dc_validation_eventdate_outofrange: Data check validation_eventdate_outofrange Check if eventDate...

Description Usage Arguments Format samplePassData sampleFailData targetDWCField checkCategory References Examples

View source: R/dc_validation_eventdate_outofrange.R

Description

This data check answers: "Is eventDate within given dates?" question.
Data check will pass if The value for eventDate within given dates. and will fail if The value for eventDate is not within given dates..
Dimension of this data check is and it's flagging type is: FLAG
Example of entries that will pass: eventDate=2001-01-01, such data check would return TRUE.
Example of entries that will fail: eventDate=2230-12-31, such data check would return FALSE.

Usage

1
2
3
4
5
dc_validation_eventdate_outofrange(
  TARGET = NULL,
  date_start = "1600-01-01",
  date_end = Sys.Date()
)

Arguments

TARGET

a vector of event date information. To pass must be within given dates (start and end).

date_start

earliest possible date.

date_end

latest possible date.

Format

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

samplePassData

The value for eventDate within given dates.

sampleFailData

The value for eventDate is not within given dates.

targetDWCField

eventDate

checkCategory

event

References

None

Examples

1
perform_dc(data_bats, 'validation_eventdate_outofrange')

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