resetStep-PipR-method: resetStep-methods

In MPIIComputationalEpigenetics/muPipeR: muPipeR

resetStep-methods

Description

Reset/undo an analysis step and all of it's dependent steps.

Usage

## S4 method for signature 'PipR'
resetStep(object, name, delete = TRUE, archiveLogs = TRUE,
  resetDependendSteps = TRUE)

Arguments

object	PipR object
name	Name for the analysis step to be reset/undone.
delete	Logical Indicating whether the step's result directory should be deleted
archiveLogs	Logical Indicating whether the step's log files should be put in an archive folder (carrying the timestamp of the execution of the reset step in its name)
resetDependendSteps	Logical indicating whether subsequent steps that depend on the reset step should also be reset.

Details

The analysis step and potentially all it's dependent steps will be marked as 'reset' in their status and associated result directories will be deleted.

Value

the modified pipeline object with the reset anlysis step(s)

Author(s)

Fabian Mueller

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