ModuleRuntime: 'ModuleRuntime' will parse and extract Input/Output/Paramter,...

In DataCanvasIO/moduleR: moduleR makes writing module easy.

Description

This function will create a runtime object(in S3) for module. In order to create a ModuleRuntime object, we should provide the following items:

spec.json

which defines the inputs/outputs/parameters of the module.

zetrt.json

the parameters at runtime.

arguments

the arguments from command line. In the format, like "A=1".

Usage

ModuleRuntime(spec_json = "spec.json", zetrt_json = NULL, args = NULL)

Arguments

spec_json	The path for "spec.json".
zetrt_json	The path for "zetrt.json". The default is NULL, which means we can get it from system environment variable "ZETRT".
args	The arguments for Input/Output with format like "A=1". The default is NULL, which means we can get it from command line arguments with "commandArgs".

Value

A S3 object.

See Also

See Screwjack about howto create a module.

Examples

  rt <- ModuleRuntime(spec_json = "/your_path/spec.json",
                      zetrt_json = "/some_path/zetrt.json")
  # Use "rt" like this:
  rt$Output$o1$Val
  rt$Input$i1$Val
  rt$Param$P1$Val

DataCanvasIO/moduleR documentation built on May 6, 2019, 1:38 p.m.