diff --git a/_pkgdown.yml b/_pkgdown.yml index e39e5f60..f6ea9914 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -71,7 +71,7 @@ navbar: - text: Writing custom validation functions href: articles/writing-custom-fns.html - text: Deploying custom validation functions - href: articles/custom-functions.html + href: articles/deploying-custom-functions.html development: mode: auto diff --git a/vignettes/articles/custom-functions.Rmd b/vignettes/articles/deploying-custom-functions.Rmd similarity index 100% rename from vignettes/articles/custom-functions.Rmd rename to vignettes/articles/deploying-custom-functions.Rmd diff --git a/vignettes/articles/validate-pr.Rmd b/vignettes/articles/validate-pr.Rmd index 896ac158..dbfa238f 100644 --- a/vignettes/articles/validate-pr.Rmd +++ b/vignettes/articles/validate-pr.Rmd @@ -17,7 +17,7 @@ library(hubValidations) The `validate_pr()` functions is designed to be used to validate team submissions through Pull Requests on GitHub. Only model output and model metadata files are individually validated using `validate_submission()` or `validate_model_metadata()` respectively on each file according to file type -(_See the end of this article for details of the standard checks performed on each file. For more information on deploying optional or custom functions please check the article on [including custom functions](articles/custom-functions.html) (`vignette("custom-functions")`)_). +(_See the end of this article for details of the standard checks performed on each file. For more information on deploying optional or custom functions please check the article on [including custom functions](articles/deploying-custom-functions.html) (`vignette("deploying-custom-functions")`)_). As part of checks, however, hub config files are also validated. Any other files included in the PR are ignored but flagged in a message. @@ -76,7 +76,7 @@ Supplying the names of derived task IDs to argument `derived_task_ids` will igno #### Warning -Ignoring derived task IDs means that the validity of derived task ID value combinations will not be check. It is therefore **important to ensure that the values of derived task IDs are correctly derived from other task IDs through custom checks**. For example, the values of `target_end_date` can be checked by deploying optional check `opt_check_tbl_horizon_timediff()`. See the article on [including custom functions](articles/custom-functions.html) for more information. +Ignoring derived task IDs means that the validity of derived task ID value combinations will not be check. It is therefore **important to ensure that the values of derived task IDs are correctly derived from other task IDs through custom checks**. For example, the values of `target_end_date` can be checked by deploying optional check `opt_check_tbl_horizon_timediff()`. See the article on [including custom functions](articles/deploying-custom-functions.html) for more information. @@ -260,6 +260,6 @@ arrow::read_csv_arrow(system.file("check_table.csv", package = "hubValidations") #### Custom checks -The standard checks discussed here are the checks deployed by default by the `validate_pr` function. For more information on deploying optional or custom functions please check the article on [including custom functions](articles/custom-functions.html) (`vignette("custom-functions")`). +The standard checks discussed here are the checks deployed by default by the `validate_pr` function. For more information on deploying optional or custom functions please check the article on [deploying custom functions](articles/deploying-custom-functions.html) (`vignette("deploying-custom-functions")`). diff --git a/vignettes/articles/validate-submission.Rmd b/vignettes/articles/validate-submission.Rmd index f8717b3a..e3abef95 100644 --- a/vignettes/articles/validate-submission.Rmd +++ b/vignettes/articles/validate-submission.Rmd @@ -163,6 +163,6 @@ arrow::read_csv_arrow(system.file("check_table.csv", package = "hubValidations") #### Custom checks The standard checks discussed here are the checks deployed by default by the `validate_submission` or `validate_model_metadata` functions. -For more information on deploying optional/custom functions or functions that require configuration please check the article on [including custom functions](articles/custom-functions.html) (`vignette("custom-functions")`). +For more information on deploying optional/custom functions or functions that require configuration please check the article on [including custom functions](articles/deploying-custom-functions.html) (`vignette("deploying-custom-functions")`). diff --git a/vignettes/articles/writing-custom-fns.qmd b/vignettes/articles/writing-custom-fns.qmd index c7edb733..56ad1f5b 100644 --- a/vignettes/articles/writing-custom-fns.qmd +++ b/vignettes/articles/writing-custom-fns.qmd @@ -21,7 +21,7 @@ While `hubValidations` provides a wide range of validation `check_*()` functions This guide will help you understand how to write custom check functions and what tools are available in `hubValidations` to help. -While more details about deploying custom check functions during validation workflows are available in **`vignette("custom-functions")`**, it's useful to mention here that custom functions are configured through the `validations.yml` file and executed as part of `validate_model_data()`, `validate_model_metadata()` and `validate_model_file()` functions. +While more details about deploying custom check functions during validation workflows are available in **`vignette("deploying-custom-functions")`**, it's useful to mention here that custom functions are configured through the `validations.yml` file and executed as part of `validate_model_data()`, `validate_model_metadata()` and `validate_model_file()` functions. # Anatomy of a check function