linx_rmd: Generate LINX R Markdown HTML Report

Description Usage Arguments Value

View source: R/rmd.R

Description

Generates a LINX R Markdown HTML report. It does so by:

  1. recursively copy the table and plot directories into tmp/plot and tmp/table

  2. copy the rmd into tmp/linx.Rmd

  3. render the rmd inside tmp/

  4. return the path to the output HTML

Usage

1
linx_rmd(sample, table_dir, plot_dir, out_file = NULL, quiet = FALSE)

Arguments

sample

Name of sample.

table_dir

Path to LINX table directory.

plot_dir

Path to LINX plot directory.

out_file

Path to output HTML file (needs '.html' suffix).

quiet

Suppress printing during rendering.

Value

Path to rendered HTML report.


umccr/gpgr documentation built on Feb. 11, 2022, 6:26 p.m.