qat_analyse_lim_rule_dynamic_2d: Perform a dynamic lim-rule-check

Description Usage Arguments Details Value Warning Author(s) References See Also Examples

View source: R/qat_analyse_lim_rule_dynamic_2d.R

Description

This check tests data on whether it exceeds a dynamic threshold.

Usage

1
2
3
qat_analyse_lim_rule_dynamic_2d(measurement_vector, min_vector = NULL, 
max_vector = NULL, min_vector_name = NULL, max_vector_name = NULL, 
min_vector_identifier = NULL, max_vector_identifier = NULL)

Arguments

measurement_vector

The measurement vector (2d array), which should be tested

min_vector

A 2d array which consists of the minimum threshold values, with the same dimensions like the measurement vector

max_vector

A 2d array which consists of the maximum threshold values, with the same dimensions like the measurement vector

min_vector_name

A name or title of the minimum vector, which will be given back in the result

max_vector_name

A name or title of the maximum vector, which will be given back in the result

max_vector_identifier

The identifier of the maximum vector

min_vector_identifier

The identifier of the minimum vector

Details

This tests tests every element, on whether it exceeds the minimum or maximum threshold. The result will be given back as a list, which contains the result of the test as a flagvector (2d array) and its parameters. For every element of the measurement vector the flagvector contains a -1, if its exceeding its dedicated minimum vector element, a 1, if its exceeding its dedicated maximum vector element, or a 0, when no exceeding has happend. NaN-values in the measurement vector will be given back as a 0 in the flagvector, NaN-values in the minimum or maximum-vector are considered as not existing. There is no checking, if the maximum-vector is greater than the minimum-vector.

Value

It returns a list with the following entries:

flagvector

A vector of length of measurement vector. For every element of the measurement vector the flagvector contains a -1, if its exceeding its dedicated minimum vector element, a 1, if its exceeding its dedicated maximum vector element, or a 0, when no exceeding has happend.

min_vector

Give back the given min\_vector

max_vector

Give back the given max\_vector

min_vector_name

Give back the given min\_vector\_name

max_vector_name

Give back the given max\_vector\_name

Warning

There is no checking, if the maximum-vector is greater than the minimum-vector.

Author(s)

Andre Duesterhus

References

Meek, D.W., Hatfield, J.L. (1994) Data quality checking for single station meteorological databases, \_Agricultural and Forest Meteorology\_, *69* (1-2), 85-109.

See Also

qat_analyse_lim_rule_dynamic_1d, qat_plot_lim_rule_dynamic_2d, qat_call_lim_rule, qat_analyse_lim_rule_static_2d, qat_analyse_lim_rule_sigma_2d

Examples

1
2
3
4
5
vec <- array(rnorm(100),c(5,20))
min_vector<-array(rnorm(100)-2,c(5,20))
max_vector<-array(rnorm(100)+2,c(5,20))
result <- qat_analyse_lim_rule_dynamic_2d(vec, min_vector, max_vector, 
min_vector_name="minimum vector", max_vector_name="maximum vector")

qat documentation built on May 30, 2017, 8:27 a.m.