generateReport {analysisPipelines}R Documentation

Generate a HTML report from an AnalysisPipeline object

Description

Generate a HTML report from an AnalysisPipeline object

Usage

generateReport(object, path)

## S4 method for signature 'AnalysisPipeline,character'
generateReport(object, path = ".")

Arguments

object

object that contains input, pipeline, registry and output

path

path on the file system, where the generated html report should be stored

Details

The sequence of operations stored in the AnalysisPipeline object are run, outputs generated, and a HTML report is generated with outputs in the same sequence as the pipeline created by the user

Value

Updated AnalysisPipeline object

See Also

Other Package core functions for batch/one-time analyses: AnalysisPipeline-class, checkSchema, initialize,BaseAnalysisPipeline-method

Examples

## Not run: 
pipelineObj <- AnalysisPipeline(input = iris)
pipelineObj %>>% univarCatDistPlots(uniCol = "Species", storeOutput = T) -> pipelineObj
pipelineObj %>>% generateReport(path = ".")

## End(Not run)

[Package analysisPipelines version 1.0.2 Index]