reportInit: Copy default configuration file and report contents to new...

View source: R/reportInit.R

reportInitR Documentation

Copy default configuration file and report contents to new directory

Description

reportInit allows creation new report instances, or updates, from the soilReports R package. soilReports is a container for reports and convenience functions for soil data summary, comparison, and evaluation reports used mainly by USDA-NRCS staff.

Usage

reportInit(
  reportName,
  outputDir = NULL,
  overwrite = FALSE,
  updateReport = FALSE
)

Arguments

reportName

Name of report, as found in listReports. Format: directory/reportName.

outputDir

Directory to create report instance

overwrite

Overwrite existing directories and files? Default FALSE

updateReport

Only update core report files, leaving configuration unchanged? Specific settings are report-dependent and set in the setup.R manifest.

Value

A time-stamped report instance created in outputDir, and a message summarizing the action(s) completed.


ncss-tech/soilReports documentation built on April 25, 2024, 1:03 a.m.