funcreporter: Generate a parameterized report from template

Description Usage Arguments Examples

View source: R/funcreporter.R

Description

Generate a parameterized report from template

Usage

1
2
3
4
5
6
7
8
9
funcreporter(
  template_name,
  output_format = "html_document",
  output_file,
  params = NULL,
  remove_copied_template_files = TRUE,
  envir = new.env(),
  ...
)

Arguments

template_name

Template name from package.

output_format

The R Markdown output format to convert to, e.g. "html_document", "pdf_document".

output_file

The name of the output file. Non-existent directories will be created recursively.

params

A list of named parameters.

remove_copied_template_files

An option to remove copied template files after rendering.

envir

The environment in which the code chunks are to be evaluated during knitting.

...

Other options forwarded to rmarkdown::render

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
library(funcreporter)
set_funcreporter_pkg("funcreporter")
funcreporter(
    template_name = "Sample Template",
    output_format = "html_document",
    output_file = "versicolor-report",
    params = list(species = "versicolor"))

## End(Not run)

daranzolin/funcreporter documentation built on March 31, 2021, 10:44 a.m.