validate_compound_taskid_set {hubEnsembles} | R Documentation |
Perform validations on the compound task ID set used to calculate an ensemble of
component model outputs for the sample output type, including checks that
(1) compound_taskid_set
is a subset of task_id_cols
, (2) the provided
model_out_tbl
is compatible with the specified compound_taskid_set
, and
(3) all models submit predictions for the same set of non compound_taskid_set
variables.
Description
Perform validations on the compound task ID set used to calculate an ensemble of
component model outputs for the sample output type, including checks that
(1) compound_taskid_set
is a subset of task_id_cols
, (2) the provided
model_out_tbl
is compatible with the specified compound_taskid_set
, and
(3) all models submit predictions for the same set of non compound_taskid_set
variables.
Usage
validate_compound_taskid_set(
model_out_tbl,
task_id_cols,
compound_taskid_set,
derived_task_ids = NULL,
return_missing_combos = FALSE
)
Arguments
model_out_tbl |
an object of class |
task_id_cols |
|
compound_taskid_set |
Defaults to NA. Derived task ids must be included if all of the task ids their
values depend on are part of the |
derived_task_ids |
|
return_missing_combos |
|
Value
If model_out_tbl
passes the validations, there will be no return value.
Otherwise, the function will either throw an error if return_missing_combos
is
FALSE, or a data.frame
of the missing combinations of dependent tasks will be
returned. See above for more details.