maf_data_set_wrapper_unload_data: Unload data from memory

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

Unload data from memory

Description

Uses the functions in maf_dataset_wrapper to load data into the loaded_data element and update status.

Usage

maf_data_set_wrapper_unload_data(maf_dataset_wrapper)

Arguments

maf_dataset_wrapper

the wrapper of the dataset you want to unload into memory (maf_dataset_wrapper)

Value

a copy of the original wrapper with status and loaded data elements updated. Status is changed from "ready" => "not_loaded". loaded_data is changed from maf_object to NA. (maf_dataset_wrapper)

See Also

Other data_set_wrapper_loading: maf_data_set_wrapper_load_data()

Examples

#Generate wrapper
my_data <- CRUX:::tcga_dataset_to_maf_dataset_wrapper(
  maf_data_pool = CRUX:::new_maf_data_pool(), 
  tcga_study_abbreviation = "ACC"
)

#Load data
my_data <- CRUX:::maf_data_set_wrapper_load_data(my_data)

#Access loaded data
print(my_data$loaded_data)

#Unload when finished
my_data <- CRUX:::maf_data_set_wrapper_unload_data(my_data)

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