PipelineDefinition {pipeComp} | R Documentation

## PipelineDefinition

### Description

Creates on object of class 'PipelineDefinition' containing step functions, as well as optionally step evaluation and aggregation functions.

### Usage

    PipelineDefinition(
      functions,
      descriptions = NULL,
      evaluation = NULL,
      aggregation = NULL,
      initiation = identity,
      defaultArguments = list(),
      misc = list(),
      verbose = TRUE
    )

### Arguments

`functions` | A list of functions for each step
`descriptions` | A list of descriptions for each step
`evaluation` | A list of optional evaluation functions for each step
`aggregation` | A list of optional aggregation functions for each step
`initiation` | A function ran when initiating a dataset
`defaultArguments` | A lsit of optional default arguments
`misc` | A list of whatever.
`verbose` | Whether to output additional warnings (default TRUE).

### Value

An object of class 'PipelineDefinition', with the slots functions, descriptions, evaluation, aggregation, defaultArguments, and misc.

### See Also

`PipelineDefinition-methods`, `addPipelineStep`. For an example pipeline, see `scrna_pipeline`.

### Examples

    PipelineDefinition(
      list( step1=function(x, meth1){ get(meth1)(x) },
            step2=function(x, meth2){ get(meth2)(x) } )
    )

[Package pipeComp version 1.0.0 Index]