fun.Report.File: Generate Reports, File

In leppott/ContDataQC: Quality Control (QC) of Continous Monitoring Data

Generate Reports, File

Description

Subfunction for generating reports. Needs to be called from ContDataQC(). Requires knitr() and pandoc. Different reports (in Word) are created using the RMD files in this package depending on the input fun.myFile.Prefix. Values are "QC", "DATA", or "STATS". The 'file' version works on a single (or vector) of files.

Usage

fun.Report.File(
  fun.myFile,
  fun.myDir.import = getwd(),
  fun.myDir.export = getwd(),
  fun.myFile.Prefix,
  fun.myReport.format,
  fun.myReport.Dir
)

Arguments

fun.myFile	Single file name.
fun.myDir.import	Directory for import data. Default is current working directory.
fun.myDir.export	Directory for export data. Default is current working directory.
fun.myFile.Prefix	Valid prefixes are "QC", "DATA", or "STATS". This determines the RMD to use for the output.
fun.myReport.format	Report format (docx or html). Default is specified in config.R (docx). Can be customized in config.R; ContData.env$myReport.Format.
fun.myReport.Dir	Report (rmd) template folder. Default is the package rmd folder. Can be customized in config.R; ContData.env$myReport.Dir.

Value

Creates a Word (or HTML) file in the specified directory.

Examples

#Not intended to be accessed independent of function ContDataQC().

leppott/ContDataQC documentation built on Jan. 5, 2025, 10:12 a.m.