combine_qc: Combine Quality Checking Results

Description Usage Arguments Details Value

Description

Combine quality checking results depending whether they have a fixed or cumulative effect or any combination of these effects. It is also checked how should NAs be interpreted.

Usage

1
combine_qc(x, qc_names, additive = NULL, na_as = NULL)

Arguments

x

A data frame with column names.

qc_names

A vector of names of data frame columns to combine.

additive

A vector of logical values (TRUE or FALSE) for the qc_names subset of x that determines if the flags should be treated as additive (additive = TRUE) or with fixed effect (additive = FALSE). If only one value is provided, all columns are considered to be of the same type. If NULL (default), values are determined for each of specified qc_names from their attribute additive.

na_as

A vector of numeric or NA values for the qc_names subset of x that determines how should be the missing flags interpreted. If only one value is provided, all columns are treated the same way. If NULL (default), values are determined for each of specified qc_names from their attribute na_as.

Details

The quality checking results must be provided as a data frame with columns containing quality flags resulting from individual tests/filters. For all flags over all rows, the maximum and cumulative sum is taken for columns with fixed and additive effect, respectively.

Typical values of argument na.as are NA, 0 or 2. NA value is only formal and does not suggest any change in interpretation. Value 0 is used in the case that the NA value of the quality test/filter is an expected result and means that the half-hour was not checked by or has a good quality according to the given test/filter (e.g. despike). Value 2 would be used only if the user wants to explicitly specify that NA flag value should not be used for further analyses.

Value

A vector with attributes varnames and units is produced. varnames value is set by name_out argument and units value is set to default "-".


grahamstewart12/tidyflux documentation built on June 4, 2019, 7:44 a.m.