user_to_dataset_to_data_pool: Add User Data to data pool

In CCICB/CRUX: Easily explore patterns of somatic variation in cancer using 'CRUX'

Add User Data to data pool

Description

Takes a filepath to user dataset + some medata and creates a maf_dataset_wrapper object, then adds the wrapper to the maf_data_pool

Usage

user_to_dataset_to_data_pool(
  maf_data_pool,
  filepath,
  clinicalData = NA,
  display_name,
  short_name,
  description = "User specified file",
  data_source = "USER",
  loaded_data = NA
)

Arguments

maf_data_pool	the data pool to add the dataset wrapper to (maf_data_pool)
filepath	path to maf file
clinicalData	Clinical data associated with each sample/Tumor_Sample_Barcode in MAF. Could be a text file or a data.frame. Default NULL.
display_name	Name that the end-user will see (string)
short_name	Abbreviated dataset name (string)
description	dataset description
data_source	data source
loaded_data	the loaded R object (MAF or NA)

Value

returns a data pool object with extra dataset added (maf_data_pool)

See Also

Other DataToWrapper: tcga_dataset_to_data_pool(), tcga_dataset_to_maf_dataset_wrapper(), tcga_datasets_to_data_pool(), user_data_filepath_to_class_maf_dataset_wrapper()

CCICB/CRUX documentation built on Jan. 28, 2024, 10:12 p.m.