runPipeline: Run a pipeline

Description Usage Arguments Details Value See Also Examples

Description

Executes a pipeline's components.

Usage

1
runPipeline(pipeline, targetDirectory = getwd())

Arguments

pipeline

A pipeline object

targetDirectory

File path for pipeline output

Details

This function creates a directory named for pipeline, in a directory called ‘pipelines’, in the targetDirectory (‘targetDirectory/pipelines/$NAME$’). If the directory ‘pipelines’ does not exist in targetDirectory it will be created. Working files and output from the pipeline's components will be stored in the named directory.

The function returns a pipelineResult list object, containing a list of output objects produced by the pipeline's components.

Value

pipelineResult object

See Also

pipelineResult objects. More about pipeline objects, run single module objects with runModule.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
simpleGraph <-
    loadPipeline(name = "simpleGraph",
                 ref = system.file("extdata", "simpleGraph",
                                   "pipeline.xml",
                                    package = "conduit"))

## run the pipeline
result1 <- runPipeline(simpleGraph, targetDirectory = tempdir())

## python language example
pythonExample <- loadPipeline("pythonExample",
                              system.file("extdata", "pythonExample",
                                          "pipeline.xml", package="conduit"))
result2 <- runPipeline(pythonExample, targetDirectory = tempdir())

## bash language example
bashExample <- loadPipeline("bashExample",
                             system.file("extdata", "bashExample",
                                         "pipeline.xml", package="conduit"))
result3 <- runPipeline(bashExample, targetDirectory = tempdir())

## A pipeline with a module run on a remote host
## Not run: 
  irisplots_host_pipeline <- loadPipeline(
      "irisplots_host_pipeline",
      system.file("extdata", "irisplots_host", "pipeline.xml",
      package = "conduit"))
  runPipeline(irisplots_host_pipeline, targetDirectory = tempdir())

## End(Not run)

anhinton/conduit documentation built on May 10, 2019, 11:48 a.m.