dc_validation_mindepth_maxdepth_outofrange: Data check validation_mindepth_maxdepth_outofrange Check if...

In bd-R/bdchecks: Biodiversity Data Checks

Description

This data check answers: "Are minimumDepthInMeters and maximumDepthInMeters within parameter range?" question.
Data check will pass if Values for minimumDepthInMeters and maximumDepthInMeters are within given numbers. and will fail if Values for minimumDepthInMeters and maximumDepthInMeters are not within given numbers..
Dimension of this data check is and it's flagging type is: FLAG
Example of entries that will pass: maximumDepthInMeters=100, such data check would return TRUE.
Example of entries that will fail: maximumDepthInMeters=20000, such data check would return FALSE.

Usage

dc_validation_mindepth_maxdepth_outofrange(
  TARGET = NULL,
  lower_depth = 0,
  upper_depth = 11000
)

Arguments

TARGET	a vector of minimum or maximum depth in meters. To pass it must be within lower and upper depth parameters.
lower_depth	a numeric value for a lower depth.
upper_depth	a numeric value for an upper depth.

Format

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

samplePassData

Values for minimumDepthInMeters and maximumDepthInMeters are within given numbers.

sampleFailData

Values for minimumDepthInMeters and maximumDepthInMeters are not within given numbers.

targetDWCField

minimumDepthInMeters, maximumDepthInMeters

checkCategory

location

References

None

Examples

perform_dc(data_bats, 'validation_mindepth_maxdepth_outofrange')

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