Skip to content

Commit

Permalink
Add a sentence describing what the example check does
Browse files Browse the repository at this point in the history
  • Loading branch information
annakrystalli committed Oct 10, 2024
1 parent 58b48cb commit 429e251
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion vignettes/articles/deploying-custom-functions.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ Within the default configuration, individual checks can be configured for each o

#### Deploying optional `hubValidations` functions

Here's an example configuration for a single optional `hubValidations` check (`opt_check_tbl_horizon_timediff()`) to be run as part of the `validate_model_data()` validation function which checks the content of the model data submission files.
Here's an example configuration for a single optional `hubValidations` check, `opt_check_tbl_horizon_timediff()`, which checks that the temporal difference between the values in two date columns (defined by additional arguments `t0_colname` & `t1_colname`) is equal to a time period defined by horizon values (contained in a column defined by `horizon_colname`) and the length of a single horizon defined by argument `timediff`.

The check is to be run as part of the `validate_model_data()` validation function which checks the content of the model data submission files.

```{r, eval=FALSE, code=readLines(system.file('testhubs/flusight/hub-config/validations.yml', package = 'hubValidations'))}
```
Expand Down

0 comments on commit 429e251

Please sign in to comment.