specmine (version 4.0.0)

subset_samples_by_metadata_values: Subset samples by metadata values

Description

Selects a set of samples by the value of a metadata variable.

Usage

subset_samples_by_metadata_values(dataset, metadata.varname, values)

Value

A dataset object with the same structure as the input, containing only samples whose `metadata.varname` value matches one of the requested `values`.

Arguments

dataset

Dataset to subset.

metadata.varname

Metadata variable name.

values

Values to keep.

Examples

data <- matrix(
  c(1, 2, 3, 4, 5, 6),
  nrow = 2,
  dimnames = list(c("x1", "x2"), c("s1", "s2", "s3"))
)
metadata <- data.frame(
  class = factor(c("A", "B", "A")),
  row.names = c("s1", "s2", "s3")
)
dataset <- list(data = data, metadata = metadata)
subset_samples_by_metadata_values(dataset, "class", "A")