colOrderStats,dgCMatrix-method {sparseMatrixStats}R Documentation

Calculates an order statistic for each row (column) of a matrix-like object

Description

Calculates an order statistic for each row (column) of a matrix-like object.

Usage

## S4 method for signature 'dgCMatrix'
colOrderStats(x, rows = NULL, cols = NULL, which = 1, na.rm = FALSE)

## S4 method for signature 'dgCMatrix'
rowOrderStats(x, rows = NULL, cols = NULL, which = 1, na.rm = FALSE)

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.

which

An integer index in [1,K] ([1,N]) indicating which order statistic to be returned

na.rm

If TRUE, NAs are excluded first, otherwise not.

Details

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

Value

Returns a numeric vector of length N (K).

See Also

Examples

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

[Package sparseMatrixStats version 1.0.5 Index]