runModule: Execute a 'module"s source(s)

Description Usage Arguments Details Value See Also Examples

Description

Execute the scripts contained in or referenced by a module's sources.

Usage

1
2
runModule(module, targetDirectory = getwd(), inputObjects = NULL,
  warnVersion = FALSE)

Arguments

module

module object

targetDirectory

File path for module output

inputObjects

Named list of input objects

warnVersion

should conduit warn if module language version requirements are not met

Details

This function:

If the module has inputs the inputObjects list must have a named absolute file location for each input which is not resolveable based on only the input provided.

targetDirectory must exist or the function will return an error.

This function creates a directory named for the module in the targetDirectory if it does not already exist. Outputs generated by the module source scripts are stored in this directory. A module XML file which will provide the original module's output is also created in this directory.

If module$host is not NULL the remote host must exist and be accessible by conduit or this function will fail.

If warnVersion is TRUE this function will give a warning when the executing language does not meet the module's moduleLanguage requirments.

Value

moduleResult

See Also

module, moduleSource, moduleLanguage for creating modules, moduleResult for result objects

Examples

1
2
3
4
5
6
## run a module with no inputs
mod1xml <- system.file("extdata", "simpleGraph", "createGraph.xml", 
		       package = "conduit")
mod1 <- loadModule("createGraph", 
		      ref = mod1xml)
result1 <- runModule(module = mod1, targetDirectory = tempdir())

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