GetClusteringInput: Get 'Benchmark' clustering input

In davnovak/SingleBench: Framework for benchmarking and optimising dimension-reduction and clustering pipelines in expression data analysis

Description

Extracts the input to a clustering tool that is part of a benchmark sub-pipeline that was set up previously. If a dimension-reduction tool precedes the clustering tool, the latent-space projection from that tool is retrieved. Otherwise, the original expression data is retrieved.

Usage

GetClusteringInput(
  benchmark,
  idx.subpipeline,
  idx.n_param = NULL,
  null_if_exprs = FALSE
)

Arguments

benchmark	object of type Benchmark
idx.subpipeline	integer: index of a sub-pipeline of benchmark
idx.n_param	integer: index of an n-parameter iteration of a sub-pipeline of benchmark
null_if_exprs	logical: whether to return NULL instead of original expression data. Default value is FALSE

See Also

• Benchmark: constructs a Benchmark object (benchmark pipeline set-up)\

• Evaluate: runs all benchmark sub-pipelines and scores the performance of each tool

davnovak/SingleBench documentation built on Dec. 19, 2021, 9:10 p.m.