createReportScripts: Create a new NCIEA report directory

View source: R/createReportScripts.R

createReportScriptsR Documentation

Create a new NCIEA report directory

Description

Create master/parent documents appropriate for use with the NCIEA RMarkdown template.

Usage

createReportScripts(report_config, rmd_file_list, bookdown=TRUE, pagedown=TRUE)

Arguments

report_config

List. A named list with elements to be turned into YAML and RMD master/parent files in the creation of a NCIEA report.

rmd_file_list

List. A named list of RMD child documents to be included in the report. Additional information such as file order and paths also included.

bookdown

Logical. Should bookdown files (‘_bookdown_site.yml’ and ‘index.Rmd’) be created.

pagedown

Logical. Should pagedown files (master/parent named by report/appendix title) be created.

Value

Returns one or more .yml and/or .Rmd files that contain the required report meta-data and child file structure/order to produce an NCIEA themed report/bookdown site.


CenterForAssessment/Literasee documentation built on July 2, 2023, 6:21 p.m.