colIQRs {DelayedMatrixStats} | R Documentation

## Estimates of the interquartile range for each row (column) in a matrix

### Description

Estimates of the interquartile range for each row (column) in a matrix.

### Usage

    colIQRs(x, rows = NULL, cols = NULL, na.rm = FALSE, ...)

    rowIQRs(x, rows = NULL, cols = NULL, na.rm = FALSE, ...)

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

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

### Arguments

`x` | A NxK DelayedMatrix.
`rows` | A `vector` indicating subset of elements (or rows and/or columns) to operate over. If `NULL`, no subsetting is done.
`cols` | A `vector` indicating subset of elements (or rows and/or columns) to operate over. If `NULL`, no subsetting is done.
`na.rm` | If `TRUE`, missing values are dropped first, otherwise not.
`...` | Additional arguments passed to specific methods.
`force_block_processing` | `FALSE` (the default) means that a seed-aware, optimised method is used (if available). This can be overridden to use the general block-processing strategy by setting this to `TRUE` (typically not advised). The block-processing strategy loads one or more (depending on `getOption("DelayedArray.block.size")`) columns (`colFoo()`) or rows (`rowFoo()`) into memory as an ordinary base::array.

### Value

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

### Missing values

Contrary to `IQR`, which gives an error if there are missing values and `na.rm = FALSE`, `iqr()` and its corresponding row and column-specific functions return `NA`_real_.

### See Also

See `IQR`. See `rowSds`().

### Examples

    # A DelayedMatrix with a 'matrix' seed
    dm_matrix <- DelayedArray(matrix(c(rep(1L, 5),
                                       as.integer((0:4) ^ 2),
                                       seq(-5L, -1L, 1L)),
                                     ncol = 3))
    # A DelayedMatrix with a 'Matrix' seed
    dm_Matrix <- DelayedArray(Matrix::Matrix(c(rep(1L, 5),
                                               as.integer((0:4) ^ 2),
                                               seq(-5L, -1L, 1L)),
                                             ncol = 3))

    colIQRs(dm_matrix)

    # Only using rows 2-4
    rowIQRs(dm_matrix, rows = 2:4)

[Package DelayedMatrixStats version 1.0.3 Index]