nuget server logo nuget api documents
↑

API Docs / REnv / ranking

ranking

Full name SMRUCC.Rsharp.Runtime.Internal.Invokes.ranking Assembly REnv Members 2

01 Syntax

SMRUCC.Rsharp.Runtime.Internal.Invokes.ranking

02 Methods

NameOverloadsSummary
rank 1 Sample Ranks Returns the sample ranks of the values in a vector.
order 1 Ordering Permutation order returns a permutation which rearranges its first argument into ascending or descending order, breaking ties by further arguments.

03 Members

method rank #
rank(Object, Boolean, Strategies)

Sample Ranks

Returns the sample ranks of the values in a vector. Ties (i.e., equal values) and missing values can be handled in several ways.

Remarks

If all components are different (and no NAs), the ranks are well defined, with values in seq_along(x). With some values equal (called ‘ties’), the argument ties.method determines the result at the corresponding indices. The "first" method results in a permutation with increasing values at each index set of ties, and analogously "last" with decreasing values. The "random" method puts these in random order whereas the default, "average", replaces them by their mean, and "max" and "min" replaces them by their maximum and minimum respectively, the latter being the typical sports ranking.

NA values are never considered to be equal: for na.last = TRUE and na.last = FALSE they are given distinct ranks in the order in which they occur in x.

NB: rank is not itself generic but xtfrm is, and rank(xtfrm(x), ....) will have the desired result if there is a xtfrm method. Otherwise, rank will make use of ==, >, is.na and extraction methods for classed objects, possibly rather slowly.

Parameters
NameTypeDescription
xObject

a numeric, complex, character Or logical vector.

na_lastBoolean

For controlling the treatment of NAs. If TRUE, missing values in the data are put last; if FALSE, they are put first; if NA, they are removed; if "keep" they are kept with rank NA.

ties_methodStrategies

a character string specifying how ties are treated, see ‘Details’; can be abbreviated.

Returns

A numeric vector of the same length as x with names copied from x (unless na.last = NA, when missing values are removed). The vector is of integer type unless x is a long vector or ties.method = "average" when it is of double type (whether or not there are any ties).

method order #
order(Object, Boolean, Object, Environment)

Ordering Permutation

order returns a permutation which rearranges its first argument into ascending or descending order, breaking ties by further arguments. sort.list is the same, using only one argument.

Remarks

In the case of ties in the first vector, values in the second are used to break the ties. If the values are still tied, values in the later arguments are used to break the tie (see the first example). The sort used is stable (except for method = "quick"), so any unresolved ties will be left in their original ordering.

Complex values are sorted first by the real part, then the imaginary part.

Except for method "radix", the sort order for character vectors will depend on the collating sequence of the locale in use: see Comparison.

The "shell" method is generally the safest bet and is the default method, except for short factors, numeric vectors, integer vectors and logical vectors, where "radix" is assumed. Method "radix" stably sorts logical, numeric and character vectors in linear time. It outperforms the other methods, although there are caveats (see sort). Method "quick" for sort.list is only supported for numeric x with na.last = NA, is not stable, and is slower than "radix".

partial = NULL is supported for compatibility with other implementations of S, but no other values are accepted and ordering is always complete.

For a classed R object, the sort order is taken from xtfrm: as its help page notes, this can be slow unless a suitable method has been defined or is.numeric(x) is true. For factors, this sorts on the internal codes, which is particularly appropriate for ordered factors.

Parameters
NameTypeDescription
xObject

a sequence of numeric, complex, character or logical vectors, all of the same length, or a classed R object.

decreasingBoolean

logical. Should the sort order be increasing or decreasing? For the "radix" method, this can be a vector of length equal to the number of arguments in .... For the other methods, it must be length one.

Returns

An integer vector unless any of the inputs has 2^31 or more elements, when it is a double vector.