colMads {DelayedMatrixStats} | R Documentation

## Standard deviation estimates for each row (column) in a matrix

### Description

Standard deviation estimates for each row (column) in a matrix.

### Usage

    colMads(x, rows = NULL, cols = NULL, center = NULL, constant = 1.4826,
      na.rm = FALSE, dim. = dim(x), ...)

    colSds(x, rows = NULL, cols = NULL, na.rm = FALSE, center = NULL,
      dim. = dim(x), ...)

    rowMads(x, rows = NULL, cols = NULL, center = NULL, constant = 1.4826,
      na.rm = FALSE, dim. = dim(x), ...)

    rowSds(x, rows = NULL, cols = NULL, na.rm = FALSE, center = NULL,
      dim. = dim(x), ...)

    ## S4 method for signature 'DelayedMatrix'
    colMads(x, rows = NULL, cols = NULL,
      center = NULL, constant = 1.4826, na.rm = FALSE, dim. = dim(x),
      force_block_processing = FALSE, ...)

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

    ## S4 method for signature 'DelayedMatrix'
    rowMads(x, rows = NULL, cols = NULL,
      center = NULL, constant = 1.4826, na.rm = FALSE, dim. = dim(x),
      force_block_processing = FALSE, ...)

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

### 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.
`center` | (optional) The center, defaults to the row means for the SD estimators and row medians for the MAD estimators.
`constant` | A scale factor. See `mad` for details.
`na.rm` | If `TRUE`, `NA`s are excluded first, otherwise not.
`dim.` | An `integer` `vector` of length two specifying the dimension of `x`, also when not a `matrix`.
`...` | 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).

### See Also

`sd`, `mad` and `var`. `rowIQRs`().

### 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)))
    # A DelayedMatrix with a 'DataFrame' seed
    dm_DF <- DelayedArray(S4Vectors::DataFrame(C1 = rep(1L, 5),
                                               C2 = as.integer((0:4) ^ 2),
                                               C3 = seq(-5L, -1L, 1L)))

    colMads(dm_df)

    colSds(dm_df)

    rowMads(dm_DF)

    rowSds(dm_DF)

[Package DelayedMatrixStats version 1.0.3 Index]