activate_mass_dataset: Activate a Specific Dataset

View source: R/9-activate_mass_dataset.R

activate_mass_datasetR Documentation

Activate a Specific Dataset

Description

Activates a dataset within the mass dataset object for further analysis.

Usage

activate_mass_dataset(
  .data,
  what = c("sample_info", "variable_info", "expression_data", "annotation_table")
)

Arguments

.data

A mass_dataset object.

what

A character string specifying which dataset to activate. The available options are:

  • "sample_info": Activates the sample information dataset.

  • "variable_info": Activates the variable information dataset.

  • "expression_data": Activates the expression data.

  • "annotation_table": Activates the annotation table.

By default, it activates the "sample_info" dataset.

Details

This function allows users to activate a specific dataset within the mass_dataset object. The activated dataset can be then used in subsequent analysis steps.

Value

Returns the mass_dataset object with the specified dataset activated.

Author(s)

Xiaotao Shen shenxt1990@outlook.com

Examples

data("expression_data")
data("sample_info")
data("variable_info")

object =
  create_mass_dataset(
    expression_data = expression_data,
    sample_info = sample_info,
    variable_info = variable_info
  )
object
object@activated
object =
  activate_mass_dataset(.data = object, what = "sample_info")
object@activated

tidymass/massdataset documentation built on Jan. 30, 2024, 2:55 p.m.