use_param_report_template: Template files for a parameterized report

View source: R/use_.R

use_param_report_templateR Documentation

Template files for a parameterized report

Description

Parameterized reports allow to create reports in a loop. Examples might be site specific quality reports or recruitment reports.

Usage

use_param_report_template(save_as, open = TRUE, ...)

Arguments

save_as

filename to save the files as (do not include extension as multiple files are created)

open

logical indicating whether to open the file

...

other arguments passed to use_template

Details

This function creates 2 files as a barebones template for such parameterized reports. An Rmd file is created (based on the UNIBE template) and an R file containing a small loop. Currently, the you have to supervise this loop, as use_ubreportclo (which relies on usethis::use_template) will not overwrite files without being given explicit permission.

Value

saves two files, an Rmd and an R file

Examples

# use_param_report_template("param")

CTU-Bern/CTUtemplate documentation built on Feb. 27, 2025, 7:21 p.m.