From b0a5c23e6b872bae2e665021a54ba1b4a1008cf4 Mon Sep 17 00:00:00 2001 From: Anna Krystalli Date: Thu, 10 Oct 2024 14:59:36 +0300 Subject: [PATCH] attempt to fix vignette references --- vignettes/articles/validate-pr.Rmd | 6 +++--- vignettes/articles/validate-submission.Rmd | 6 +++--- vignettes/articles/writing-custom-fns.Rmd | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/vignettes/articles/validate-pr.Rmd b/vignettes/articles/validate-pr.Rmd index dbfa238f..cebe58a3 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/deploying-custom-functions.html) (`vignette("deploying-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](deploying-custom-functions.html) (`vignette("articles/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. @@ -215,7 +215,7 @@ check_for_errors(v_pass, verbose = TRUE) ## `validate_pr` check details -For details on the structure of `` objects, including on how to access more information about specific checks, see `vignette("hub-validations-class")`. +For details on the structure of `` objects, including on how to access more information about specific checks, see `vignette("articles/hub-validations-class")`. ### Checks on model output files @@ -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 [deploying custom functions](articles/deploying-custom-functions.html) (`vignette("deploying-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](deploying-custom-functions.html) (`vignette("articles/deploying-custom-functions")`). diff --git a/vignettes/articles/validate-submission.Rmd b/vignettes/articles/validate-submission.Rmd index e3abef95..281b4f9c 100644 --- a/vignettes/articles/validate-submission.Rmd +++ b/vignettes/articles/validate-submission.Rmd @@ -29,7 +29,7 @@ validate_submission(hub_path, ) ``` -For more details on the structure of `` objects, including how to access more information on individual checks, see `vignette("hub-validations-class")`. +For more details on the structure of `` objects, including how to access more information on individual checks, see `vignette("articles/hub-validations-class")`. ### Validation early return @@ -136,7 +136,7 @@ validate_model_metadata(hub_path, ``` -For more details on the structure of `` objects, including how to access more information on individual checks, see `vignette("hub-validations-class")`. +For more details on the structure of `` objects, including how to access more information on individual checks, see `vignette("articles/hub-validations-class")`. ### `validate_model_metadata` check details @@ -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/deploying-custom-functions.html) (`vignette("deploying-custom-functions")`). +For more information on deploying optional/custom functions or functions that require configuration please check the article on [including custom functions](deploying-custom-functions.html) (`vignette("articles/deploying-custom-functions")`). diff --git a/vignettes/articles/writing-custom-fns.Rmd b/vignettes/articles/writing-custom-fns.Rmd index a79e6630..5230281c 100644 --- a/vignettes/articles/writing-custom-fns.Rmd +++ b/vignettes/articles/writing-custom-fns.Rmd @@ -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("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. +While more details about deploying custom check functions during validation workflows are available in **`vignette("articles/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