dc_validation_minelevation_outofrange: Data check validation_minelevation_outofrange Check if...

Description Usage Arguments Format samplePassData sampleFailData targetDWCField checkCategory References Examples

View source: R/dc_validation_minelevation_outofrange.R

Description

This data check answers: "Is minimumElevationInMeters within parameter range?" question.
Data check will pass if The value for minimumElevationInMeters within given numbers. and will fail if The value for minimumElevationInMeters is not within given numbers..
Dimension of this data check is and it's flagging type is: FLAG
Example of entries that will pass: minimumElevationInMeters=0, such data check would return TRUE.
Example of entries that will fail: minimumElevationInMeters=9999, such data check would return FALSE.

Usage

1
2
3
4
5
dc_validation_minelevation_outofrange(
  TARGET = NULL,
  lower_limit = -428,
  upper_limit = 8850
)

Arguments

TARGET

a vector of minimum elevation meters. To pass it must be within lower and upper limits.

lower_limit

a numeric value for a lower limit.

upper_limit

a numeric value for an upper limit.

Format

An object of class function to perform a specific data check.

samplePassData

The value for minimumElevationInMeters within given numbers.

sampleFailData

The value for minimumElevationInMeters is not within given numbers.

targetDWCField

minimumElevationInMeters

checkCategory

location

References

None

Examples

1
perform_dc(data_bats, 'validation_minelevation_outofrange')

bd-R/bdchecks documentation built on Oct. 8, 2021, 5:10 p.m.