create_report: Make a New Rmd from a Template

In meerapatelmd/suzyBakeOven: Helpers for Package Authoring

Make a New Rmd from a Template

Description

Make a copy of a template Rmd file and replace the variables within curly brackets. If a value for a bracketed variable within the template folder is missing, the file will not be written. All templates are required to have an issue_key and report_title. If a report of the same issue_key and report_title already exists, it will not be overwritten. Sometimes a template will have child Rmds. See 'create_child_report()' to create template children.

Usage

create_report(
  issue_key,
  report_title,
  project_path = getwd(),
  github_page_path = "",
  source_code_page_path = "",
  template_path = system.file(package = "easyBakeOven", "reports", "Generic.Rmd"),
  require_all_vars = TRUE,
  edit_file = TRUE,
  ...
)

Arguments

issue_key	Issue identifier.
report_title	Name of the new report. It cannot contain any forward slashes.
project_path	Project path assigned to the new Rmd file.
github_page_path	Path to the GitHub site that will host the html output if the feature is enabled.
source_code_page_path	Path to the GitHub repository source code for the Rmd file.
template_path	Path to the template file to use. It can point to a template Rmd in your local machine.
require_all_vars	Variables to replace are designated as those enclosed in curly brackets in the template Rmd file. Sometimes, the template may have variables to be called upon by the glue function iteratively outside the template itself. This argument controls whether or not all of these variables must be assigned a value or not. Default: TRUE.
edit_file	If called in an interactive session, the file will be opened in R Studio if TRUE.
...	(Optional) Additional parameters that should be added in the front matter of the Rmd. Should be entered in the format of a named vector.

See Also

read_utf8 cli_alert dir.create_path

meerapatelmd/suzyBakeOven documentation built on March 30, 2022, 1:44 p.m.