subset: Subsetting vector-like, matrix-like and data-frame-like...

In BiocGenerics: S4 generic functions used in Bioconductor

Description

Return subsets of vector-like, matrix-like or data-frame-like objects which meet conditions.

NOTE: This man page is for the subset S4 generic function defined in the BiocGenerics package. See ?base::subset for the subset S3 generic defined in the base package.

Usage

subset(x, ...)

Arguments

x	A vector-like, matrix-like or data-frame-like object to be subsetted.
...	Additional arguments (e.g. subset, select, drop), for use in specific methods. See ?base::subset for more information.

Value

An object similar to x containing just the selected elements (for a vector-like object), or the selected rows and columns (for a matrix-like or data-frame-like object).

See Also

• base::subset in the base package for the subset S3 generic.

• showMethods for displaying a summary of the methods defined for a given generic function.

• selectMethod for getting the definition of a specific method.

• subset,RectangularData-method in the S4Vectors package for an example of a specific subset method (defined for RectangularData derivatives).

• BiocGenerics for a summary of all the generics defined in the BiocGenerics package.

Examples

subset
showMethods("subset")
selectMethod("subset", "ANY")  # the default method

library(S4Vectors)
showMethods("subset")
## The subset() method for RectangularData derivatives:
selectMethod("subset", "RectangularData")

Example output

Loading required package: parallel

Attaching package: ‘BiocGenerics’

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

    clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,
    clusterExport, clusterMap, parApply, parCapply, parLapply,
    parLapplyLB, parRapply, parSapply, parSapplyLB

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

    IQR, mad, sd, var, xtabs

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

    anyDuplicated, append, as.data.frame, basename, cbind, colnames,
    dirname, do.call, duplicated, eval, evalq, Filter, Find, get, grep,
    grepl, intersect, is.unsorted, lapply, Map, mapply, match, mget,
    order, paste, pmax, pmax.int, pmin, pmin.int, Position, rank,
    rbind, Reduce, rownames, sapply, setdiff, sort, table, tapply,
    union, unique, unsplit, which.max, which.min

standardGeneric for "subset" defined from package "base"

function (x, ...) 
standardGeneric("subset")
<environment: 0x564bc5ca66e8>
Methods may be defined for arguments: x
Use  showMethods("subset")  for currently available ones.
Function: subset (package base)
x="ANY"

Method Definition (Class "derivedDefaultMethod"):

function (x, ...) 
UseMethod("subset")
<bytecode: 0x564bc46652b8>
<environment: namespace:base>

Signatures:
        x    
target  "ANY"
defined "ANY"
Loading required package: stats4

Attaching package: ‘S4Vectors’

The following object is masked from ‘package:base’:

    expand.grid

Function: subset (package base)
x="ANY"
x="RectangularData"
x="Vector"

Method Definition:

function (x, ...) 
{
    .local <- function (x, subset, select, drop = FALSE, ...) 
    {
        i <- evalqForSubset(subset, x, ...)
        j <- evalqForSelect(select, x, ...)
        x[i, j, drop = drop]
    }
    .local(x, ...)
}
<bytecode: 0x564bc8391a88>
<environment: namespace:S4Vectors>

Signatures:
        x                
target  "RectangularData"
defined "RectangularData"

BiocGenerics documentation built on April 17, 2021, 6:01 p.m.