rowVars {MatrixGenerics}R Documentation

Calculates the variance for each row (column) of a matrix-like object

Description

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

Usage

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

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

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

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

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

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

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

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

Arguments

x

An NxK matrix-like object.

rows, cols

A vector indicating the subset of rows (and/or columns) to operate over. If NULL, no subsetting is done.

na.rm

If TRUE, NAs are excluded first, otherwise not.

center

(optional) the center, defaults to the row means.

...

Additional arguments passed to specific methods.

dim.

An integer vector of length two specifying the dimension of x, essential when x is a numeric vector. Note, that this is not a generic argument and not all methods need provide it.

Details

The S4 methods for x of type matrix, array, or numeric call matrixStats::rowVars / matrixStats::colVars.

Value

Returns a numeric vector of length N (K).

See Also

Examples

  mat <- matrix(rnorm(15), nrow = 5, ncol = 3)
  mat[2, 1] <- NA
  mat[3, 3] <- Inf
  mat[4, 1] <- 0
  
  print(mat)
  
  rowVars(mat)
  colVars(mat)
[Package MatrixGenerics version 0.99.0 Index]