addStep-PipR-method: addStep-methods

addStep,PipR-methodR Documentation

addStep-methods

Description

Add an analysis step to the pipeline

Usage

## S4 method for signature 'PipR'
addStep(object, name, cmd, args = NULL,
  parents = character())

Arguments

object

PipR object

name

A name for the analysis step. will be used as an identifier

cmd

Command(s)/Tool(s) pertaining to the analysis step as character vector. If the vector is of length 1 (single string), the command will be recycled for all args elements

args

Command/Tool arguments pertaining to the analysis step as list of character vectors. There should be one list element for each command.

parents

Character vector specifying the names of other analysis steps the new step depends on. These steps must already be in the pipeline object.

Details

The new analysis step will be registered and scheduled for running using the run,PipR-method command.

Value

the modified pipeline object containing the added analysis step

Author(s)

Fabian Mueller


MPIIComputationalEpigenetics/muPipeR documentation built on Oct. 18, 2022, 2:35 a.m.