colRanges-dgCMatrix-method: Calculates the minimum and maximum for each row (column) of a...

In const-ae/sparseMatrixStats: Summary Statistics for Rows and Columns of Sparse Matrices

Calculates the minimum and maximum for each row (column) of a matrix-like object

Description

Calculates the minimum and maximum for each row (column) of a matrix-like object.

Usage

## S4 method for signature 'dgCMatrix'
colRanges(x, rows = NULL, cols = NULL, na.rm = FALSE, useNames = TRUE)

## S4 method for signature 'dgCMatrix'
rowRanges(x, rows = NULL, cols = NULL, na.rm = FALSE, useNames = TRUE)

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, missing values (NA or NaN) are omitted from the calculations.
useNames	If TRUE (default), names attributes of result are set. Else if FALSE, no naming support is done.

Details

The S4 methods for x of type matrix, array, table, or numeric call matrixStats::rowRanges / matrixStats::colRanges.

Value

a numeric Nx2 (Kx2) matrix, where N (K) is the number of rows (columns) for which the ranges are calculated.

Note

Unfortunately for the argument list of the rowRanges() generic function we cannot follow the scheme used for the other row/column matrix summarization generic functions. This is because we need to be compatible with the historic rowRanges() getter for RangedSummarizedExperiment objects. See ?SummarizedExperiment::rowRanges.

See Also

• matrixStats::rowRanges() and matrixStats::colRanges() which are used when the input is a matrix or numeric vector.

• For max estimates, see rowMaxs().

• For min estimates, see rowMins().

• base::range().

Examples

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

print(mat)

rowRanges(mat)
colRanges(mat)

const-ae/sparseMatrixStats documentation built on June 15, 2024, 9:36 a.m.