# Compose Interoperable Analysis Pipelines & Put Them in Production

## Documentation for package ‘analysisPipelines’ version 1.0.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

analysisPipelines-package | analysisPipelines
AnalysisPipeline | Class for constructing Analysis Pipelines for batch/ one-time analyeses
AnalysisPipeline-class | Class for constructing Analysis Pipelines for batch/ one-time analyeses
analysisPipelines | analysisPipelines
assessEngineSetUp | Assesses engine (R, Spark, Python, Spark Structured Streaming) set up
assessEngineSetUp-method | Assesses engine (R, Spark, Python, Spark Structured Streaming) set up
BaseAnalysisPipeline | Base class for 'AnalysisPipeline' and 'StreamingAnalysisPipeline' objects
BaseAnalysisPipeline-class | Base class for 'AnalysisPipeline' and 'StreamingAnalysisPipeline' objects
bivarPlots | Bi-Variate Plot
castKafkaStreamAsString | Connect to a Spark session
CheckColumnType | Check for type of column
checkSchemaMatch | Checks the schema of the input to a Pipeline object against the original
checkSchemaMatch-method | Checks the schema of the input to a Pipeline object against the original
convertKafkaValueFromJson | Connect to a Spark session
correlationMatPlot | Correlation Matrix Plot
createPipelineInstance | Create a Pipeline object from a meta-pipeline
createPipelineInstance-method | Create a Pipeline object from a meta-pipeline
exportAsMetaPipeline | Method to export a meta-pipeline
exportAsMetaPipeline-method | Method to export a meta-pipeline
generateOutput | Generate a list of outputs from Pipeline objects
generateOutput-method | Generate a list of outputs from Pipeline objects
generateReport | Generate a HTML report from an 'AnalysisPipeline' object
generateReport-method | Generate a HTML report from an 'AnalysisPipeline' object
genericPipelineException | Default exception for pipeline functions
getDatatype | Get Data Type
getFeaturesForPyClassification | Extracts selected columns from a data frame as a Python array
getInput | Obtains the initializedInput
getInput-method | Obtains the initializedInput
getLoggerDetails | Obtains the logger configuration for the pipeline
getLoggerDetails-method | Obtains the logger configuration for the pipeline
getOutputById | Obtains a specific output
getOutputById-method | Obtains a specific output
getPipeline | Obtain the pipeline
getPipeline-method | Obtain the pipeline
getPipelinePrototype | Obtain the prototype of the functions in the pipeline
getPipelinePrototype-method | Obtain the prototype of the functions in the pipeline
getRegistry | Obtains the function registry
getResponse | Obtains the response term from the formula
getTargetForPyClassification | Extracts selected column from a data frame a binary class Python array
getTerm | Obtains the dependency term from the formula
ignoreCols | Ignores the columns in the loaded dataframe object
isDependencyParam | Checks if the parameter is the dependency parameter
loadMetaPipeline | Load a meta-pipeline
loadPipeline | Loads the 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object from the file system
loadPredefinedFunctionRegistry | Loading the registry of predefined functions
loadRegistry | Loads a function registry from a file
MetaAnalysisPipeline | Class for creating and working with meta-pipelines
MetaAnalysisPipeline-class | Class for creating and working with meta-pipelines
multiVarOutlierPlot | Multi-Variate Outlier Plot
outlierPlot | Outlier detection plot
prepExecution | Prepare the pipleline for execution
prepExecution-method | Prepare the pipleline for execution
registerFunction | Register a user-defined function to be used with a 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object
savePipeline | Saves the 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object to the file system without outputs
savePipeline-method | Saves the 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object to the file system without outputs
saveRegistry | Saves the registry to the file system
setInput | Sets the input for an 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object
setInput-method | Sets the input for an 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object
setLoggerDetails | Sets the logger configuration for the pipeline
setLoggerDetails-method | Sets the logger configuration for the pipeline
setPythonEnvir | Sets the python environment to be used
sparkRSessionCreateIfNotPresent | Connect to a Spark session
StreamingAnalysisPipeline | Class for constructing Analysis Pipelines for streaming analyeses
StreamingAnalysisPipeline-class | Class for constructing Analysis Pipelines for streaming analyeses
univarCatDistPlots | Univariate Categoric Distribution
updateObject | Update the 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object by adding an operation to the pipeline
updateObject-method | Update the 'AnalysisPipeline' or 'StreamingAnalysisPipeline' object by adding an operation to the pipeline
visualizePipeline | Visualizes the pipeline as a graph
visualizePipeline-method | Visualizes the pipeline as a graph