colIQRs,dgCMatrix-method {sparseMatrixStats} | R Documentation

## Calculates the interquartile range for each row (column) of a matrix-like object

### Description

Calculates the interquartile range for each row (column) of a matrix-like object.

### Usage

    ## S4 method for signature 'dgCMatrix'
    colIQRs(x, rows = NULL, cols = NULL, na.rm = FALSE)

    ## S4 method for signature 'dgCMatrix'
    rowIQRs(x, rows = NULL, cols = NULL, na.rm = FALSE)

### Arguments

`x` | An NxK matrix-like object.
`rows` | A `vector` indicating the subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`cols` | A `vector` indicating the subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`na.rm` | If `TRUE`, `NA`s are excluded first, otherwise not.

### Details

The S4 methods for `x` of type `matrix`, `array`, or `numeric` call `matrixStats::rowIQRs` / `matrixStats::colIQRs`.

### Value

Returns a `numeric` `vector` of length N (K).

### See Also

- `matrixStats::rowIQRs()` and `matrixStats::colIQRs()` which are used when the input is a `matrix` or `numeric` vector.

- For a non-robust analog, see `rowSds()`. For a more robust version see `rowMads()`

- `stats::IQR()`.

### Examples

    mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
      mat[2, 1] <- NA
      mat[3, 3] <- Inf
      mat[4, 1] <- 0

      print(mat)

      rowIQRs(mat)
      colIQRs(mat)

[Package sparseMatrixStats version 1.0.5 Index]