user_data_filepath_to_class_maf_dataset_wrapper: Title

View source: R/data_wrapping_user_imports.R

user_data_filepath_to_class_maf_dataset_wrapperR Documentation

Title

Description

Title

Usage

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

Arguments

filepath

tab delimited MAF file. File can also be gz compressed. Required. Alternatively, you can also provide already read MAF file as a dataframe.

clinicalData

Clinical data associated with each sample/Tumor_Sample_Barcode in MAF. Could be a text file or a data.frame. Default NULL.

maf_data_pool

A maf_data_pool object. Used to check supplied 'unique_name' is actually going to be unique. If not, characaters are appended to make it truly unique in the context of the supplied dataframe. (maf_data_pool)

display_name

Name that the end-user will see (string)

short_name

Abbreviated dataset name (string)

description

description (string)

data_source

data source (string)

loaded_data

the loaded R object (MAF or NA)

Value

maf_dataset_wrapper

See Also

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


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