analysisPipelines (version 1.0.2)

getPipelinePrototype: Obtain the prototype of the functions in the pipeline

Description

Obtain the prototype of the functions in the pipeline

Usage

getPipelinePrototype(metaPipelineObj)
# S4 method for MetaAnalysisPipeline
getPipelinePrototype(metaPipelineObj)

Arguments

metaPipelineObj

A MetaAnalysisPipeline object

Value

An object og class proto from the 'proto' package

Details

This method returns the prototype of functions in the pipeline and their respective arguments as proto object. Functions in the pipeline can be accessed easily by using the '$' operator, and within the functions the arguments can be accessed the same way. These can be accessed and set to new values. This pipeline prototype can then be passed to the createPipelineInstance method which will instantiate an executable pipeline with the inputs set in the prototype

See Also

Other Package core functions: BaseAnalysisPipeline-class, MetaAnalysisPipeline-class, assessEngineSetUp, checkSchemaMatch, createPipelineInstance, exportAsMetaPipeline, generateOutput, genericPipelineException, getInput, getLoggerDetails, getOutputById, getPipeline, getRegistry, initDfBasedOnType, initialize,BaseAnalysisPipeline-method, loadMetaPipeline, loadPipeline, loadPredefinedFunctionRegistry, loadRegistry, prepExecution, registerFunction, savePipeline, saveRegistry, setInput, setLoggerDetails, updateObject, visualizePipeline

Examples

# NOT RUN {
pipelineObj <- AnalysisPipeline(input = iris)
pipelineObj %>>% univarCatDistPlots(uniCol = "Species") %>>%
 exportAsMetaPipeline %>>% getPipelinePrototype
# }