colQuantiles {DelayedMatrixStats} | R Documentation

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

### Description

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

### Usage

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

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

    ## S4 method for signature 'DelayedMatrix'
    colQuantiles(x, rows = NULL, cols = NULL,
      probs = seq(from = 0, to = 1, by = 0.25), na.rm = FALSE, type = 7L,
      force_block_processing = FALSE, ..., drop = TRUE)

    ## S4 method for signature 'DelayedMatrix'
    rowQuantiles(x, rows = NULL, cols = NULL,
      probs = seq(from = 0, to = 1, by = 0.25), na.rm = FALSE, type = 7L,
      force_block_processing = FALSE, ..., drop = TRUE)

### Arguments

`x` | A NxK DelayedMatrix.
`rows` | A `vector` indicating subset of rows (and/or columns) to operate over. If `NULL`, no subsetting is done.
`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 specific methods.
`drop` | If TRUE, singleton dimensions in the result are dropped, otherwise not.
`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` NxJ (KxJ) `matrix`, where N (K) is the number of rows (columns) for which the J quantiles are calculated.

### See Also

`quantile`.

### Examples

    # A DelayedMatrix with a 'data.frame' seed
    dm_df <- DelayedArray(data.frame(C1 = rep(1L, 5),
                                     C2 = as.integer((0:4) ^ 2),
                                     C3 = seq(-5L, -1L, 1L)))

    # colnames, if present, are preserved as rownames on output
    colQuantiles(dm_df)

    # Input has no rownames so output has no rownames
    rowQuantiles(dm_df)

[Package DelayedMatrixStats version 1.0.3 Index]