run_step: run_step

Description Usage Arguments Value

Description

Processes a single step in the pipeline. Runs the step, if applicable. Runs checks, if applicable.

Usage

1
run_step(transform, type, inpaths = "", outpaths = "", ...)

Arguments

transform

list. A named list of characters. The first element should be the function name. All other elements optional parameters into the function.

type

character. The type of transformation done for this step. Can be one of five values: '0f1' - For functions with no input sets, creating one output set. '0fM' - For functions with no input sets, creating multiple output sets. Sets must be returned in the same order that they're named in the pipeline. '1f1' - For functions with one input set and one output set. '1fM' - For functions with one input set and multiple output sets. Sets must be returned in the same order that they're named in the pipeline. 'Mf1' - For functions requiring multiple input sets, but producing only one output set. Sets must be input in the order that they will be passed into the transformation function. 'MfM' - For functions with multiple inputs and multiple outputs. Input and output sets must be the same length. Element one of the input set produces element one of the output set. 'MbM' - for functions with multiple inputs and multiple outputs. Input and output sets may be of arbitrary length. Elements of the input set are fed into the transform via do.call, and the output sets must be returned in the order they are named in the pipeline.

inpaths

character. A vector of one or more of the set names used as inputs to this step.

outpaths

character. A vector of one or more of the set names created by this step.

...

list. A list of optional parameters to be set as local configs for that particular step. Any config not specified in the step gets set to the global values for that config.

Value

If run_checks == FALSE, the output is a list of the storage paths created by the pipeline. If run_checks == TRUE, the output is a dataframe listing each step, set created, and value for all check functions. Only run if run_pipe = TRUE Only run if run_checks = TRUE Function run_all_checks will take in list of outpaths and list of checks


christiantillich/PipR documentation built on Feb. 27, 2020, 7:52 p.m.