pipeline: Create a pipeline

In anhinton/conduit: A prototype glue system for OpenAPI

Description

This functions create a new pipeline object.

Usage

pipeline(name, description = NULL, components = list(), pipes = list())

Arguments

name	pipeline name
description	pipeline description
components	list of module and pipeline objects
pipes	list of pipe objects

Value

pipeline list containing:

name	character value
description	character value
components	list of modules and pipelines
pipes	list of pipes

See Also

loadPipeline for loading a pipeline from an XML souce, module for information on module objects, runPipeline for executing all of a pipeline's components, runModule for executing individual module objects, pipe for pipes, and addPipe and addComponent for modifying pipelines.

Examples

## create some modules
mod1 <- module(name = "setX", language = moduleLanguage("R"),
               description = "sets the value of x",
               outputs = list(
                   moduleOutput(
                       name = "x",
                       vessel = internalVessel("x"),
                       format = ioFormat("R character string"))),
               sources = list(
                   moduleSource(
                       vessel = scriptVessel("x <- \"set\""))))
mod2 <- module("showY", language = moduleLanguage("R"),
               description = "displays the value of Y",
               inputs = list(
                   moduleInput(
                       name = "y",
                       vessel = internalVessel("y"),
                       format = ioFormat("R character string"))),
               sources = list(
                   moduleSource(
                       vessel = scriptVessel("print(y)"))))
pline1 <- pipeline(name = "trivialpipeline", components = list(mod1, mod2))
## create a pipe
pipe1 <- pipe("setX", "x",
              "showY", "y")
## create a pipeline
pline1 <- pipeline(name = "ex_pipeline",
                   components = list(mod1, mod2), 
                   pipes = list(pipe1))

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