Skip to contents

Check model output data tbl round ID matches submission round ID.

Source: R/check_tbl_match_round_id.R
check_tbl_match_round_id.Rd

Check model output data tbl round ID matches submission round ID.

Usage

check_tbl_match_round_id(tbl, file_path, hub_path, round_id_col = NULL)

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.

round_id_col

Character string. The name of the column containing round_ids. Usually, the value of round property round_id in hub tasks.json config file. Defaults to NULL and determined from the config if applicable.

Value

Depending on whether validation has succeeded, one of:

  • <message/check_success> condition class object.

  • <error/check_error> condition class object.

If round_id_from_variable: false and no round_id_col name is provided, check is skipped and a <message/check_info> condition class object is returned. If no valid round_id_col name is provided or can extracted from config (check through check_valid_round_id_col), a <message/check_error> condition class object is returned and the rest of the check skipped.

Details

This check only applies to files being submitted to rounds where round_id_from_variable: true or where a round_id_col name is explicitly provided. Skipped otherwise.