graphMng: Step graph management

Description Usage Arguments Value Examples

Description

The step relations are managed and restricted to directed acyclic graph. The direction of data flow is from upstream to downstream. So when users create a new step object, restricting its relation with existing steps is necessary.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
addEdges(edges, argOrder)

getPrevSteps(stepType, argOrder)

getAttachedStep(stepType)

regAttachedStep(newStepType, stepType)

getNextSteps(stepType, argOrder)

printMap(stepType = NULL, display = TRUE, ...)

Arguments

edges

Character vector. Contain the names of start and end points for all edges. It needs to follow the format like c("startpt1","endpt1","startpt2", "endpt2","startpt3","endpt3").

argOrder

Numeric scalar. The argument order of the input Step object.

stepType

Character scalar. Step class name of each step.

newStepType

Logical scalar. give a new step step type name to the original step type with different default parameter value

display

Logical scalar. Wether show the picture on device or not.

...

Additional arguments, currently used.

Value

addEdges

No value will be returned.

getPrevSteps

Names of previous steps

getAttachedStep

get the step that is generated from

regAttachedStep

Add different step type for exist step

getNextSteps

Names of next steps

printMap

Print the flow map for the pipeline.

Examples

1
2
3
4
5
addEdges(edges = c("RandomRegionOnGenome",
                   "OverlappedRandomRegion"),argOrder = 1)
printMap()

getPrevSteps("OverlappedRandomRegion",1)

wzthu/pipeFrame documentation built on Sept. 22, 2021, 4:36 p.m.