report: report

In jasenfinch/metaboReports: Automated Report Generation For Metabolomics Analyses

Description

Automated, dynamic report generation for a metabolomic analysis.

Usage

report(analysis, parameters)

## S4 method for signature 'Binalysis'
report(analysis, parameters)

## S4 method for signature 'MetaboProfile'
report(analysis, parameters)

## S4 method for signature 'Analysis'
report(analysis, parameters)

## S4 method for signature 'Assignment'
report(analysis, parameters)

## S4 method for signature 'Workflow'
report(analysis, parameters)

Arguments

analysis	S4 object of class Binalysis, MetaboProfile, Analysis, Assignment or Workflow from which to genrate a report
parameters	object of class ReportParameters

Examples

## Not run: 
library(metaboWorkflows)

fp <- metaboData::filePaths('FIE-HRMS','BdistachyonEcotypes') 
si <- metaboData::runinfo('FIE-HRMS','BdistachyonEcotypes')

wp <- workflowParameters('FIE-HRMS fingerprinting',fp,si,breaks = FALSE)

analysis <- workflow(wp)

## For a Binalysis object
bd <- analysis %>%
 resultsProcessing()
p <- reportParameters('ExampleData','Steve French')
report(bd,p)

## For an Analysis object
ad <- analysis %>%
 resultsAnalysis()
p <- reportParameters('ExampleData','Steve French')
report(ad,p) 

## For an Assignment object
as <- analysis %>%
 resultsAnnotation()
p <- reportParameters('ExampleData','Steve French')
report(as,p) 

## For a Workflow object
p <- reportParameters('ExampleData','Steve French')
report(analysis,p) 


## End(Not run)

jasenfinch/metaboReports documentation built on Nov. 19, 2021, 7:23 p.m.