struct_DatasetExperiment: DatasetExperiment class

In computational-metabolomics/struct: Statistics in R Using Class-based Templates

DatasetExperiment class

Description

An object for holding raw data and associated meta data

Usage

DatasetExperiment(
  data = data.frame(),
  sample_meta = data.frame(),
  variable_meta = data.frame(),
  ...
)

## S4 method for signature 'DatasetExperiment'
x$name

## S4 replacement method for signature 'DatasetExperiment'
x$name <- value

Arguments

data	A data frame with samples in rows and features in columns
sample_meta	A data frame with samples in rows and meta data in columns
variable_meta	A data frame with features in rows and meta data in columns
...	named slot values to pass through to struct_class
x	A DatasetExperiment object
name	DatasetExperiment slot to get/set
value	the value to assign to the named slot

Details

The DatasetExperiment object is an extension of the SummarizedExperiment object from the SummarizedExperiment package (found on Bioconductor). It incorporates the basic functionality of struct objects, containing fields such as Description, Name and Type with features of SummarizedExperiment such as subsetting.

There are some important differences between DatasetExperiment and SummarizedExperiment:

• In DatasetExperiment data is stored as Samples (rows) x Features (columns)

• DatasetExperiment currently only supports a single assay

• length(DatasetExperiment) returns the number of samples

Value

DatasetExperiment

Slots

name

Name of the dataset

description

Brief description of the dataset

type

The type of dataset e.g. single_block

computational-metabolomics/struct documentation built on March 27, 2024, 4:26 p.m.