R: Estimates quantiles for each row (column) in a matrix

rowQuantiles {matrixStats} | R Documentation

## Estimates quantiles for each row (column) in a matrix

### Description

Estimates quantiles for each row (column) in a matrix.

### Usage

    rowQuantiles(x, rows = NULL, cols = NULL, probs = seq(from = 0, to =
      1, by = 0.25), na.rm = FALSE, type = 7L, ..., drop = TRUE)

    colQuantiles(x, rows = NULL, cols = NULL, probs = seq(from = 0, to =
      1, by = 0.25), na.rm = FALSE, type = 7L, ..., drop = TRUE)

### Arguments

`x` | A `numeric` NxK `matrix` with N >= 0.
`rows, cols` | A `vector` indicating subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`probs` | A `numeric` `vector` of J probabilities in [0, 1].
`na.rm` | If `TRUE`, `NA`s are excluded first, otherwise not.
`type` | An `integer` specify the type of estimator. See `quantile` for more details.
`...` | Additional arguments passed to `quantile`.
`drop` | If TRUE, singleton dimensions in the result are dropped, otherwise not.

### Value

Returns a `numeric` NxJ (KxJ) `matrix`, where N (K) is the number of rows (columns) for which the J quantiles are calculated.

### Author(s)

Henrik Bengtsson

### See Also

`quantile`.

### Examples

    set.seed(1)

    x <- matrix(rnorm(50 * 40), nrow = 50, ncol = 40)
    str(x)

    probs <- c(0.25, 0.5, 0.75)

    # Row quantiles
    q <- rowQuantiles(x, probs = probs)
    print(q)
    q_0 <- apply(x, MARGIN = 1, FUN = quantile, probs = probs)
    stopifnot(all.equal(q_0, t(q)))

    # Column IQRs
    q <- colQuantiles(x, probs = probs)
    print(q)
    q_0 <- apply(x, MARGIN = 2, FUN = quantile, probs = probs)
    stopifnot(all.equal(q_0, t(q)))

[Package matrixStats version 0.55.0 Index]