rowRanks {MatrixGenerics} | R Documentation |
Calculates the rank of the elements for each row (column) of a matrix-like object
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"),
..., useNames = NA)
## 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), ..., useNames = NA)
## S4 method for signature 'ANY'
rowRanks(x, rows = NULL, cols = NULL,
ties.method = c("max", "average"), ..., useNames = NA)
colRanks(x, rows = NULL, cols = NULL, ties.method = c("max", "average"),
..., useNames = NA)
## 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, ...,
useNames = NA)
## S4 method for signature 'ANY'
colRanks(x, rows = NULL, cols = NULL,
ties.method = c("max", "average"), ..., useNames = NA)
Arguments
x |
An NxK matrix-like object. |
rows , cols |
A |
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. |
useNames |
If |
dim. |
An |
preserveShape |
If |
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()
andmatrixStats::colRanks()
which are used when the input is amatrix
ornumeric
vector.
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)