Check time difference between values in two date columns equals a defined time period defined by values in a horizon column

Usage

opt_check_tbl_horizon_timediff(
  tbl,
  file_path,
  hub_path,
  t0_colname,
  t1_colname,
  horizon_colname = "horizon",
  timediff = lubridate::weeks()
)

Arguments

tbl: a tibble/data.frame of the contents of the file being validated.
file_path: character string. Path to the file being validated relative to the hub's model-output directory.
hub_path: Either a character string path to a local Modeling Hub directory or an object of class <SubTreeFileSystem> created using functions s3_bucket() or gs_bucket() by providing a string S3 or GCS bucket name or path to a Modeling Hub directory stored in the cloud. For more details consult the Using cloud storage (S3, GCS) in the arrow package. The hub must be fully configured with valid admin.json and tasks.json files within the hub-config directory.
t0_colname: Character string. The name of the time zero date column.
t1_colname: Character string. The name of the time zero + 1 time step date column.
horizon_colname: Character string. The name of the horizon column. Defaults to "horizon".
timediff: an object of class lubridate Period and length 1. The period of a single horizon. Default to 1 week.

Value

Depending on whether validation has succeeded, one of:

<message/check_success> condition class object.
<warning/check_failure> condition class object.

Returned object also inherits from subclass <hub_check>.

Details

Should be deployed as part of validate_model_data optional checks.