Skip to content

Commit

Permalink
attempt to fix vignette references
Browse files Browse the repository at this point in the history
  • Loading branch information
annakrystalli committed Oct 10, 2024
1 parent 103bbd4 commit b0a5c23
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
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/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.

Expand Down Expand Up @@ -215,7 +215,7 @@ check_for_errors(v_pass, verbose = TRUE)

## `validate_pr` check details

For details on the structure of `<hub_validations>` objects, including on how to access more information about specific checks, see `vignette("hub-validations-class")`.
For details on the structure of `<hub_validations>` objects, including on how to access more information about specific checks, see `vignette("articles/hub-validations-class")`.

### Checks on model output files

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 [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")`).

</div>
6 changes: 3 additions & 3 deletions vignettes/articles/validate-submission.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ validate_submission(hub_path,
)
```

For more details on the structure of `<hub_validations>` objects, including how to access more information on individual checks, see `vignette("hub-validations-class")`.
For more details on the structure of `<hub_validations>` objects, including how to access more information on individual checks, see `vignette("articles/hub-validations-class")`.

### Validation early return

Expand Down Expand Up @@ -136,7 +136,7 @@ validate_model_metadata(hub_path,
```


For more details on the structure of `<hub_validations>` objects, including how to access more information on individual checks, see `vignette("hub-validations-class")`.
For more details on the structure of `<hub_validations>` objects, including how to access more information on individual checks, see `vignette("articles/hub-validations-class")`.

### `validate_model_metadata` check details

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

</div>
2 changes: 1 addition & 1 deletion vignettes/articles/writing-custom-fns.Rmd
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("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

Expand Down

0 comments on commit b0a5c23

Please sign in to comment.