Skip to contents

Select samples

Source: R/AllGenerics.R, R/selectSamples-methods.R
selectSamples.Rd

Utility function that enables quick and easy sample selection.

Usage

selectSamples(object, ...)

# S4 method for SummarizedExperiment
selectSamples(object, ...)

Arguments

object

Object.

...

Selection arguments:

  • Key value pairs that must map to the column names of sampleData().

  • atomic values are supported.

  • Avoid using logical or numeric indices (e.g. which() return), thereby making your code more human readable, and easier to interpret.

Value

Modified object. Subset (extraction) containing the desired samples.

Details

Internally, pattern matching against sample and file names is applied using logical grep matching.

Note

Updated 2022-08-18.

Intended usage

This function is intended to be used for sample extraction from Bioconductor container classes where the column names don't correspond to samples (e.g. SingleCellExperiment).

Bracket-based subsetting

Bracket-based subsetting with [ also works on SingleCellExperiment objects but it's not intuitive. In this case, provide cellular barcode identifiers for columns and gene identifiers for rows.

See also

Examples

data(RangedSummarizedExperiment, package = "AcidTest")

## SummarizedExperiment ====
object <- RangedSummarizedExperiment
sample <- sampleNames(object)[[1L]]
print(sample)
#> [1] "sample01"
subset <- selectSamples(object, sampleName = sample)
print(subset)
#> class: RangedSummarizedExperiment 
#> dim: 500 1 
#> metadata(3): version date interestingGroups
#> assays(1): counts
#> rownames(500): gene001 gene002 ... gene499 gene500
#> rowData names(10): broadClass description ... ncbiGeneId seqCoordSystem
#> colnames(1): sample01
#> colData names(1): condition