getSampleMetadata: Get data.table of sample metadata from CollectionWithMetadata

In VEuPathDB/veupathUtils: General Helper Functions for VEuPathDB Projects

Get data.table of sample metadata from CollectionWithMetadata

Description

Returns a data.table of sample metadata

Usage

getSampleMetadata(
  object,
  asCopy = c(TRUE, FALSE),
  includeIds = c(TRUE, FALSE),
  metadataVariables = NULL
)

## S4 method for signature 'CollectionWithMetadata'
getSampleMetadata(
  object,
  asCopy = c(TRUE, FALSE),
  includeIds = c(TRUE, FALSE),
  metadataVariables = NULL
)

## S4 method for signature 'SampleMetadata'
getSampleMetadata(object, asCopy = c(TRUE, FALSE), includeIds = c(TRUE, FALSE))

Arguments

object	CollectionWithMetadata
asCopy	boolean indicating whether to return the data as a copy or by reference
includeIds	boolean indicating whether we should include recordIdColumn and ancestorIdColumns
metadataVariables	The metadata variables to include in the sample metadata. If NULL, all metadata variables will be included.

Value

data.table of sample metadata

VEuPathDB/veupathUtils documentation built on Feb. 8, 2025, 12:29 p.m.