mitch_report: mitch_report

View source: R/mitch.R

mitch_reportR Documentation

mitch_report

Description

This function generates an R markdown based html report containing tables and several plots of mitch results The plots are in png format, so are not as high in resolution as compared to the PDF generated by mitch_plots function. The number of detailed sets to generate is dictated by the resrows set in the mitch_calc command.

Usage

mitch_report(res, outfile, overwrite = FALSE)

Arguments

res

a mitch results object.

outfile

the destination file for the html report. should contain 'html' suffix. Defaults to 'Rplots.pdf'

overwrite

should overwrite the report file if it already exists?

Value

generates a HTML file containing enrichment plots.

Examples

data(resExample)
mitch_report(resExample,'outres2.html')

markziemann/Mitch documentation built on April 19, 2024, 7:25 a.m.