analysisPipelines (version 1.0.2)

getOutputById: Obtains a specific output

Description

Obtains a specific output

Usage

getOutputById(object, reqId, includeCall = F)
# S4 method for BaseAnalysisPipeline
getOutputById(object, reqId,
  includeCall = F)

Arguments

object

The AnalysisPipeline or StreamingAnalysisPipeline object

reqId

The position of the function for which the output is desired in the sequence of operations in the pipeline.

includeCall

Logical which defines whether the call used to generate the output should be returned. By, default this is false

Value

If includeCall = F, the output object generated by the function is returned

If includeCall = T, it is a list containing to elements - call: tibble with 1 row containing the function call for the output desired - output: output generated

Details

Obtains a specific output from the AnalysisPipeline or StreamingAnalysisPipeline object by passing the position of the function for which the output is desired, in the sequence of operations in the pipeline. This can be obtained by passing the number under the 'id' column in the pipeline table corresponding to the required function

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

See Also

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

Examples

# NOT RUN {
library(analysisPipelines)
pipelineObj <- AnalysisPipeline(input = iris)
getNumRows <- function(dataset){
  return(nrow(dataset))
}
registerFunction("getNumRows")
pipelineObj %>>% getNumRows(storeOutput = TRUE) -> pipelineObj
pipelineObj %>>% generateOutput %>>% getOutputById("1")
# }