updateObject {analysisPipelines}R Documentation

Update the AnalysisPipeline or StreamingAnalysisPipeline object by adding an operation to the pipeline

Description

Update the AnalysisPipeline or StreamingAnalysisPipeline object by adding an operation to the pipeline

Usage

updateObject(object, operation, heading = "", parameters, outAsIn = F,
  storeOutput = F)

## S4 method for signature 'BaseAnalysisPipeline'
updateObject(object, operation,
  heading = "", parameters, outAsIn = F, storeOutput = F)

Arguments

object

object that contains input, pipeline, registry and output

operation

function name to be updated in tibble

heading

heading of that section in report

parameters

parameters passed to that function

outAsIn

whether to use original input or output from previous function

storeOutput

whether the output of this operation is to be stored

Details

The specified operation along with the heading and parameters is updated in the pipeline slot of the AnalysisPipeline or StreamingAnalysisPipeline object, where the sequence of operations to be performed is stored

This method is implemented on the base class as it is a shared functionality types of Analysis Pipelines which extend this class

Value

Updated AnalysisPipeline StreamingAnalysisPipeline object

See Also

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


[Package analysisPipelines version 1.0.2 Index]