rowRanks: Calculates the rank of the elements for each row (column) of...

In MatrixGenerics: S4 Generic Summary Statistic Functions that Operate on Matrix-Like Objects

Description

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

Usage

rowRanks(x, rows = NULL, cols = NULL, ties.method = c("max", "average"), ...)

## S4 method for signature 'matrix_OR_array_OR_table_OR_numeric'
rowRanks(x, rows = NULL,
  cols = NULL, ties.method = c("max", "average", "first", "last", "random",
  "max", "min", "dense"), dim. = dim(x), ...)

## S4 method for signature 'ANY'
rowRanks(x, rows = NULL, cols = NULL, ties.method = c("max", "average"), ...)

colRanks(x, rows = NULL, cols = NULL, ties.method = c("max", "average"), ...)

## S4 method for signature 'matrix_OR_array_OR_table_OR_numeric'
colRanks(x, rows = NULL,
  cols = NULL, ties.method = c("max", "average", "first", "last", "random",
  "max", "min", "dense"), dim. = dim(x), preserveShape = FALSE, ...)

## S4 method for signature 'ANY'
colRanks(x, rows = NULL, cols = NULL, ties.method = c("max", "average"), ...)

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.
ties.method	A character string specifying how ties are treated. Note that the default specifies fewer options than the original matrixStats package.
...	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.
preserveShape	If TRUE the output matrix has the same shape as the input x. Note, that this is not a generic argument and not all implementation of this function have to provide it.

Details

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

The matrixStats::rowRanks() function can handle a lot of different values for the ties.method argument. Users of the generic function should however only rely on max and average because the other ones are not guaranteed to be implemented:

max

for values with identical values the maximum rank is returned

average

for values with identical values the average of the ranks they cover is returned. Note, that in this case the return value is of type numeric.

Value

a matrix of type integer is returned unless ties.method = "average". Ithas dimensions' NxJ (KxJ) matrix, where N (K) is the number of rows (columns) of the input x.

See Also

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

• base::rank

Examples

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

Example output

Loading required package: matrixStats

Attaching package: ‘MatrixGenerics’

The following objects are masked from ‘package:matrixStats’:

    colAlls, colAnyNAs, colAnys, colAvgsPerRowSet, colCollapse,
    colCounts, colCummaxs, colCummins, colCumprods, colCumsums,
    colDiffs, colIQRDiffs, colIQRs, colLogSumExps, colMadDiffs,
    colMads, colMaxs, colMeans2, colMedians, colMins, colOrderStats,
    colProds, colQuantiles, colRanges, colRanks, colSdDiffs, colSds,
    colSums2, colTabulates, colVarDiffs, colVars, colWeightedMads,
    colWeightedMeans, colWeightedMedians, colWeightedSds,
    colWeightedVars, rowAlls, rowAnyNAs, rowAnys, rowAvgsPerColSet,
    rowCollapse, rowCounts, rowCummaxs, rowCummins, rowCumprods,
    rowCumsums, rowDiffs, rowIQRDiffs, rowIQRs, rowLogSumExps,
    rowMadDiffs, rowMads, rowMaxs, rowMeans2, rowMedians, rowMins,
    rowOrderStats, rowProds, rowQuantiles, rowRanges, rowRanks,
    rowSdDiffs, rowSds, rowSums2, rowTabulates, rowVarDiffs, rowVars,
    rowWeightedMads, rowWeightedMeans, rowWeightedMedians,
    rowWeightedSds, rowWeightedVars

           [,1]       [,2]        [,3]
[1,] -1.0652962 -0.4208877  1.11048067
[2,]         NA  1.2359814 -0.05959464
[3,]  0.3360884  1.1579619         Inf
[4,]  0.0000000  0.6629415 -0.70493784
[5,]  0.7666901 -1.6795836  0.81742136
     [,1] [,2] [,3]
[1,]    1    2    3
[2,]   NA    2    1
[3,]    1    2    3
[4,]    2    3    1
[5,]    2    1    3
     [,1] [,2] [,3] [,4] [,5]
[1,]    1   NA    3    2    4
[2,]    2    5    4    3    1
[3,]    4    2    5    1    3

MatrixGenerics documentation built on Feb. 1, 2021, 2:01 a.m.