1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
\name{rank}
\alias{rank}
\title{Ranks the values in a vector-like object}
\description{
Returns the ranks of the values in a vector-like object.
Ties (i.e., equal values) and missing values can be handled in several ways.
NOTE: This man page is for the \code{rank}
\emph{S4 generic function} defined in the \pkg{BiocGenerics} package.
See \code{?base::\link[base]{rank}} for the default method
(defined in the \pkg{base} package).
Bioconductor packages can define specific methods for objects
not supported by the default method.
}
\usage{
rank(x, na.last=TRUE,
ties.method=c("average", "first", "random", "max", "min"))
}
\arguments{
\item{x}{
A vector-like object.
}
\item{na.last, ties.method}{
See \code{?base::\link[base]{rank}} for a description of
these arguments.
}
}
\value{
See \code{?base::\link[base]{rank}} for the value returned
by the default method.
Specific methods defined in Bioconductor packages should
behave as consistently as possible with the default method.
}
\note{
TO DEVELOPPERS:
See note in \code{?BiocGenerics::\link[BiocGenerics]{order}}
about "stable" order.
\code{\link[BiocGenerics]{order}}, \code{\link[BiocGenerics]{sort}},
and \code{\link[BiocGenerics]{rank}} methods for specific vector-like
objects should adhere to the same underlying order that should be
conceptually defined as a binary relation on the set of all possible
vector values. For completeness, this binary relation should also be
incarnated by a \link{<=} method.
}
\seealso{
\itemize{
\item \code{base::\link[base]{rank}} for the default \code{rank} method.
\item \code{\link[methods]{showMethods}} for displaying a summary of the
methods defined for a given generic function.
\item \code{\link[methods]{selectMethod}} for getting the definition of
a specific method.
\item \link[IRanges]{rank,Ranges-method} in the \pkg{IRanges} package
for an example of a specific \code{rank} method (defined for
\link[IRanges]{Ranges} objects).
\item \link{BiocGenerics} for a summary of all the generics defined
in the \pkg{BiocGenerics} package.
}
}
\examples{
rank # note the dispatch on the 'x' arg only
showMethods("rank")
selectMethod("rank", "ANY") # the default method
}
\keyword{methods}
|