Function reference • MassWateR

Read, check, and format data

Functions for importing, checking, and formatting the results and data quality objectives data.

readMWRresults(): Read water quality monitoring results from an external file

readMWRresultsview(): Create summary spreadsheet of the water quality monitoring results

checkMWRresults(): Check water quality monitoring results

formMWRresults(): Format water quality monitoring results

readMWRacc(): Read data quality objectives for accuracy from an external file

checkMWRacc(): Check data quality objective accuracy data

formMWRacc(): Format data quality objective accuracy data

readMWRfrecom(): Read data quality objectives for frequency and completeness from an external file

checkMWRfrecom(): Check data quality objective frequency and completeness data

formMWRfrecom(): Format data quality objective frequency and completeness data

readMWRsites(): Read site metadata from an external file

checkMWRsites(): Check site metadata file

readMWRwqx(): Read water quality exchange (wqx) metadata input from an external file

checkMWRwqx(): Check water quality exchange (wqx) metadata input

formMWRwqx(): Format WQX metadata input

Outlier analysis

Functions for evaluating outliers as plots and generating tabular output.

anlzMWRoutlier(): Analyze outliers in results file

anlzMWRoutlierall(): Analyze outliers in results file for all parameters

Quality control checks, table and report creation

Functions for running quality control checks, generating tables, and creating the overall report.

qcMWRreview(): Create the quality control review report

qcMWRacc(): Run quality control accuracy checks for water quality monitoring results

tabMWRacc(): Create a formatted table of quality control accuracy checks

qcMWRfre(): Run quality control frequency checks for water quality monitoring results

tabMWRfre(): Create a formatted table of quality control frequency checks

qcMWRcom(): Run quality control completeness checks for water quality monitoring results

tabMWRcom(): Create a formatted table of quality control completeness checks

tabMWRwqx(): Create and save tables in a single workbook for WQX upload

General analysis

Functions for creating analysis plots of the results data.

anlzMWRseason(): Analyze seasonal trends in results file

anlzMWRdate(): Analyze trends by date in results file

anlzMWRsite(): Analyze data by sites in results file

anlzMWRmap(): Analyze results with maps

Utility functions

This is a collection of functions used internally by all other functions. They are not to be called directly.

utilMWRfilter(): Filter results data by parameter, date range, site, result attributes, and/or location group

utilMWRfiltersurface(): Filter results data to surface measurements

utilMWRfre(): Prep results data for frequency checks

utilMWRhttpgrace(): Load external file from remote source, fail gracefully

utilMWRinput(): Utility function to import data as paths or data frames

utilMWRinputcheck(): Check if required inputs are present for a function

utilMWRlimits(): Fill results data as BDL or AQL with appropriate values

utilMWRoutlier(): Identify outliers in a numeric vector

utilMWRsumfun(): Verify summary function

utilMWRsummary(): Summarize a results data frame by a grouping variable

utilMWRthresh(): Get threshold lines from thresholdMWR

utilMWRtitle(): Format the title for analyze functions

utilMWRvaluerange(): Check if incomplete range in Value Range column

utilMWRyscale(): Get logical value for y axis scaling

Supplementary datasets

Supplementary datasets for the read, quality control, and analysis functions.

paramsMWR: Master parameter list and units for Characteristic Name column in results data

thresholdMWR: Master thresholds list for analysis of results data