fun.Stats: Statistical Summary

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

Statistical Summary

Description

Subfunction for generating statistical summaries. Needs to be called from ContDataQC(). Requires doBy() and survival() [required by doBy] Calculates statistics on input data and saves to a new csv.

Usage

fun.Stats(
  fun.myData.SiteID,
  fun.myData.Type,
  fun.myData.DateRange.Start,
  fun.myData.DateRange.End,
  fun.myDir.import = getwd(),
  fun.myDir.export = getwd(),
  fun.myProcedure.Step,
  fun.myFile.Prefix,
  fun.myReport.format,
  fun.myReport.Dir
)

Arguments

fun.myData.SiteID	Station/SiteID.
fun.myData.Type	data type; c("Air","Water","AW","Gage","AWG","AG" ,"WG")
fun.myData.DateRange.Start	Start date for requested data. Format = YYYY-MM-DD.
fun.myData.DateRange.End	End date for requested data. Format = YYYY-MM-DD.
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

Returns a csv into the specified export directory with additional columns for calculated statistics.

Examples

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

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