setupReportDirectory: Create a new NCIEA report directory

View source: R/NCIEA_Report_utils.R

setupReportDirectoryR Documentation

Create a new NCIEA report directory

Description

Create a new report using the NCIEA RMarkdown template and custom content templates. Wrapper function for new_nciea_report and file.copy.

Usage

setupReportDirectory(
  dir=getwd(),
  new.report=TRUE,
  update.assets=FALSE,
  custom.content=TRUE,
  custom.content.path,
  overwrite.custom=FALSE)

Arguments

dir

The directory path to establish the new report in. Defaults to the current working directory.

new.report

Logical. Whether the report is new and new ‘nciea_report’ assets should be copied.

update.assets

Logical. If report is not new, simply update Literasee package assets using updateAssets.

custom.content

Logical. Whether the templates for custom content (.Rmd files) should be copied from some directory (custom.content.path).

custom.content.path

Character. The file path location from which custom content templates will be copied.

overwrite.custom

Logical. Whether the templates for custom content should all be overwritten. Defaults to FALSE - meaning only new items will be copied.

Value

Copies assets (css, javascript, Rmd and other source files) and custom content necessary for creating a new Center for Assessment themed report.


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