qcMWRfre {MassWateR} | R Documentation |
Run quality control frequency checks for water quality monitoring results
Description
Run quality control frequency checks for water quality monitoring results
Usage
qcMWRfre(
res = NULL,
acc = NULL,
frecom = NULL,
fset = NULL,
runchk = TRUE,
warn = TRUE
)
Arguments
res |
character string of path to the results file or |
acc |
character string of path to the data quality objectives file for accuracy or |
frecom |
character string of path to the data quality objectives file for frequency and completeness or |
fset |
optional list of inputs with elements named |
runchk |
logical to run data checks with |
warn |
logical to return warnings to the console (default) |
Details
The function can be used with inputs as paths to the relevant files or as data frames returned by readMWRresults
, readMWRacc
, and readMWRfrecom
. For the former, the full suite of data checks can be evaluated with runkchk = T
(default) or suppressed with runchk = F
. In the latter case, downstream analyses may not work if data are formatted incorrectly. For convenience, a named list with the input arguments as paths or data frames can be passed to the fset
argument instead. See the help file for utilMWRinput
.
Note that frequency is only evaluated on parameters in the Parameter
column in the data quality objectives frequency and completeness file. A warning is returned if there are parameters in Parameter
in the frequency and completeness file that are not in Characteristic Name
in the results file.
Similarly, parameters in the results file in the Characteristic Name
column that are not found in the data quality objectives frequency and completeness file are not evaluated. A warning is returned if there are parameters in Characteristic Name
in the results file that are not in Parameter
in the frequency and completeness file.
Value
The output shows the frequency checks from the input files. Each row applies to a frequency check for a parameter. The Parameter
column shows the parameter, the obs
column shows the total records that apply to regular activity types, the check
column shows the relevant activity type for each frequency check, the count
column shows the number of records that apply to a check, the standard
column shows the relevant percentage required for the quality control check from the quality control objectives file, and the met
column shows if the standard was met by comparing if percent
is greater than or equal to standard
.
Examples
##
# using file paths
# results path
respth <- system.file('extdata/ExampleResults.xlsx', package = 'MassWateR')
# dqo accuracy data path
accpth <- system.file('extdata/ExampleDQOAccuracy.xlsx', package = 'MassWateR')
# frequency and completeness path
frecompth <- system.file('extdata/ExampleDQOFrequencyCompleteness.xlsx',
package = 'MassWateR')
qcMWRfre(res = respth, acc = accpth, frecom = frecompth)
##
# using data frames
# results data
resdat <- readMWRresults(respth)
# accuracy data
accdat <- readMWRacc(accpth)
# frequency and completeness data
frecomdat <- readMWRfrecom(frecompth)
qcMWRfre(res = resdat, acc = accdat, frecom = frecomdat)