DelayedOperation-class.Rd
DelayedOperation is an S4 class to store a delayed operation
Delayed operations are not applied to the dataset immediately, but rather when some data from the dataset is required. When working on large datasets, keeping all samples in RAM may be impossible, and the DelayedDatasetDisk architecture becomes convenient, where samples are stored in a directory, loaded processed and saved individually.
Under such arquitecture, it is more efficient to load a sample, run as many operations as possible on it and save the sample, instead of loading a sample, running one operation, saving the sample.
See how to create such delayed operations and more details at
vignette("creating-a-workflow-step", package = "GCIMS")
.
name
A named for de delayed operation, only used for printing.
fun
A function that takes a sample object and returns a sample object, usually with some change (filtered,...)
params
A named list with additional arguments to be passed to fun
params_iter
A named list with additional arguments to be passed to
fun
. Compared to params
, each argument must be a named list of length the number of samples, so
each sample will receive its corresponding parameter according to its name
fun_extract
A function that takes the modified sample object returned
by fun
and extracts some component out of it. This component will be stored in the dataset for faster access.
fun_aggregate
A function that takes a dataset object and a list of extracted results (the output of all fun_extract
calls)
and modifies the dataset.