R: Calculates quantiles for each row (column) of a matrix-like...

colQuantiles,xgCMatrix-method {sparseMatrixStats}

R Documentation

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

Description

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

Usage

## S4 method for signature 'xgCMatrix'
colQuantiles(
  x,
  rows = NULL,
  cols = NULL,
  probs = seq(from = 0, to = 1, by = 0.25),
  na.rm = FALSE,
  type = 7L,
  drop = TRUE
)

## S4 method for signature 'xgCMatrix'
rowQuantiles(
  x,
  rows = NULL,
  cols = NULL,
  probs = seq(from = 0, to = 1, by = 0.25),
  na.rm = FALSE,
  drop = TRUE
)

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.
`probs`	A numeric vector of J probabilities in [0, 1].
`na.rm`	If `TRUE`, `NA`s are excluded first, otherwise not.
`type`	An integer specifying the type of estimator. See `stats::quantile()`. for more details.
`drop`	If `TRUE` a vector is returned if `J == 1`.

Details

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

Value

a numeric NxJ (KxJ) matrix, where N (K) is the number of rows (columns) for which the J values are calculated.

Examples

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

[Package sparseMatrixStats version 1.2.1 Index]