colVarDiffs,dgCMatrix-method {sparseMatrixStats} | R Documentation

## Calculates the variance of the difference between each element of a row (column) of a matrix-like object

### Description

Calculates the variance of the difference between each element of a row (column) of a matrix-like object.

### Usage

    ## S4 method for signature 'dgCMatrix'
    colVarDiffs(
      x,
      rows = NULL,
      cols = NULL,
      na.rm = FALSE,
      diff = 1L,
      trim = 0,
      useNames = NA
    )

    ## S4 method for signature 'dgCMatrix'
    rowVarDiffs(
      x,
      rows = NULL,
      cols = NULL,
      na.rm = FALSE,
      diff = 1L,
      trim = 0,
      useNames = NA
    )

### 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.
`diff` | An integer specifying the order of difference.
`trim` | A double in [0,1/2] specifying the fraction of observations to be trimmed from each end of (sorted) x before estimation.
`useNames` | If `NA`, the default behavior of the function about naming support is remained. If `FALSE`, no naming support is done. Else if `TRUE`, names attributes of result are set.

### Details

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

### Value

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

### See Also

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

- for the direct variance see `rowVars()`.

### Examples

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

      print(mat)

      rowVarDiffs(mat)
      colVarDiffs(mat)

[Package sparseMatrixStats version 1.6.0 Index]