which.min {BiocGenerics} | R Documentation |
What's the index of the first min or max value in an object?
Description
Determines the location (i.e. index) of the (first) minimum or maximum value in an object.
NOTE: This man page is for the which.min
and which.max
S4 generic functions defined in the BiocGenerics package.
See ?base::which.min
for the default methods (defined
in the base package).
Bioconductor packages can define specific methods for objects (typically
vector-, array-, or list-like) not supported by the default methods.
Usage
which.min(x, ...)
which.max(x, ...)
Arguments
x |
An object, typically with a vector-, array-, or list-like semantic. |
... |
Additional arguments, for use in specific methods. |
Value
See ?base::which.min
for the value returned by the
default methods.
Specific methods defined in Bioconductor packages should behave as consistently as possible with the default methods.
Note
The default methods (defined in the base package) only take a
single argument. We've added the ...
argument to the generic
functions defined in the BiocGenerics package so they
can be called with an arbitrary number of effective arguments.
This typically allows methods to add extra arguments for
controlling/altering the behavior of the operation. Like for
example the global
argument supported by the which.max
method for NumericList objects (defined in the
IRanges package).
See Also
-
base::which.min
for the defaultwhich.min
andwhich.max
methods. -
showMethods
for displaying a summary of the methods defined for a given generic function. -
selectMethod
for getting the definition of a specific method. -
which.max,NumericList-method in the IRanges package for an example of a specific
which.max
method (defined for NumericList objects). -
BiocGenerics for a summary of all the generics defined in the BiocGenerics package.
Examples
which.min
showMethods("which.min")
selectMethod("which.min", "ANY") # the default method
which.max
showMethods("which.max")
selectMethod("which.max", "ANY") # the default method
library(IRanges)
showMethods("which.max")
## The which.max() method for NumericList objects:
selectMethod("which.max", "NumericList")