Skip to content

Commit

Permalink
rename custom-functions article to deploying-custom-functions
Browse files Browse the repository at this point in the history
  • Loading branch information
annakrystalli committed Oct 4, 2024
1 parent da3e652 commit 1d33cf0
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

File renamed without changes.
6 changes: 3 additions & 3 deletions vignettes/articles/validate-pr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

</div>

Expand Down Expand Up @@ -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")`).

</div>
2 changes: 1 addition & 1 deletion vignettes/articles/validate-submission.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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")`).

</div>
2 changes: 1 addition & 1 deletion vignettes/articles/writing-custom-fns.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 1d33cf0

Please sign in to comment.