render_report: Render diagnostic report for ClassificationCase object

In cgeisenberger/crystalmeth: Streamlined Methylation-Based Classification of Tumors

Description

Note: Will report basenames, not filenames for IDAT files

Usage

render_report(case, template, out_dir, out_file = NULL, out_type = "pdf")

Arguments

case	Object of type ClassificationCase.
template	Template (.Rmd file) to generate report.
out_dir	Output directory of report.
out_file	Name of output file, objects basename if unspecified (Default: NULL).
out_type	Output file type (html or pdf, Default: pdf)

Details

Use this function to render a diagnostic report as PDF after running the full workflow for a ClassificationCase object. Internally, render_report generates a new environment and and passes the parameters to rmarkdown::render(). Output reports can be rendered as HTML or PDF files. Please note: if out_file extension does not match out_type, out_type takes precedence and will change the extension.

Value

Full path of report file.

cgeisenberger/crystalmeth documentation built on Aug. 28, 2020, 9:35 a.m.