colOrderStats-dgCMatrix-method: Calculates an order statistic for each row (column) of a...

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

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,
  useNames = TRUE
)

## S4 method for signature 'dgCMatrix'
rowOrderStats(
  x,
  rows = NULL,
  cols = NULL,
  which = 1,
  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.
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.
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::rowOrderStats / matrixStats::colOrderStats.

Value

Returns a numeric vector of length N (K).

See Also

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

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)

const-ae/sparseMatrixStats documentation built on April 10, 2024, 5:27 p.m.