CompSiteCDF: CompSiteCDF, compare CDFs of sites

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

CompSiteCDF, compare CDFs of sites

Description

Takes as an input a data frame with date and up to 8 columns of parameter data. Column names are Date and SiteIDs and values are daily means for some measurement.

Usage

CompSiteCDF(
  file.input = NULL,
  dir.input = getwd(),
  dir.output = getwd(),
  ParamName.xlab,
  df.input = NULL
)

Arguments

file.input	Input data as CSV. Needs Date column and it will handle up to 5 SiteIDs (with data under each SiteID).
dir.input	Directory where data file is located. Default is the working directory; getwd().
dir.output	Directory where PDF file is to be saved. Default is the working directory; getwd().
ParamName.xlab	Parameter name for x-axis on plots
df.input	Optionally use existing data frame over importing file.input. Default = NULL (import file.input).

Details

More than 8 columns can be used but colors are recycled after 8 and the plot lines will be difficult to distinguish.

CDFs are generate for all data, year, season, and year/season and saved to a PDF. Winter + Year is such that December is included with the following year (e.g., Dec 2013, Jan 2014, Feb 2014 are 2014Winter).

Two plots per page are generated. The first plot is the proportion of values at a certain value. This plot is similar to a histogram. The second plot is a CDF of values. The line represents the proportion of values less than or equal to parameter values on the x-axis.

Value

Returns a PDF of CDFs.

Examples

# Variant 1 (with File)
# Load Data
myFile <- "CDF_WaterTemp_2014_MA.csv"
# example file from ContDataQC library files
myDir.input <- file.path(path.package("ContDataQC"),"extdata")
myDir.output <- tempdir()
# X Label
myXlab <- "Temperature, Water (deg C)"
# Run the Function
CompSiteCDF(file.input = myFile
           , dir.input = myDir.input
           , dir.output = myDir.output
           , ParamName.xlab = myXlab)

# Variant 2 (with Data Frame)
# Load Data
myDF <- data_CompSiteCDF
# X Label
myXlab <- "Temperature, Water (deg C)"
# Run the Function
# (output will default to working directory if not specified)
CompSiteCDF(ParamName.xlab = myXlab
            , df.input = myDF
            , dir.output = tempdir())

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