Setup DecomposeConfig — setup_DecomposeConfig • rtemis

Setup a DecomposeConfig object. DecomposeConfig is a portable, data-agnostic recipe for a decomposition pipeline: dat_path is optional, so the same config can be validated, shared, or described without data and have a path bound later (e.g. by the rtemis CLI) before decomp.

Usage

setup_DecomposeConfig(
  dat_path = NULL,
  algorithm = NULL,
  decomposition_config = NULL,
  outdir = "results/",
  verbosity = 1L
)

Arguments

dat_path: Character or NULL: Path to input data file. NULL leaves the recipe unbound; set it (or supply data) before decomp.
algorithm: Character or NULL: Decomposition algorithm. May be left NULL if decomposition_config is supplied (it carries its own algorithm).
decomposition_config: DecompositionConfig object or NULL: Configuration for the decomposition itself. Setup with a decomposition setup_* function, e.g. setup_PCA. If NULL, defaults for algorithm are used at decomp time.
outdir: Character: Output directory for results.
verbosity: Integer [0, Inf): Verbosity level.

Value

DecomposeConfig object.

Author

EDG

Examples

dc <- setup_DecomposeConfig(
  dat_path = "data.csv",
  decomposition_config = setup_PCA(k = 3L),
  outdir = "results/"
)