Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

organise function references #48

Merged
merged 1 commit into from
Oct 4, 2023
Merged

organise function references #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions _pkgdown.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,36 @@ url: https://infectious-disease-modeling-hubs.github.io/hubValidations/
template:
bootstrap: 5

reference:
- title: "Higher level validation functions"
desc: "Functions combining appropriate check unit test used for higher level validations. All return `hub_validations` S3 class objects."
contents:
- starts_with("validate_")
- check_for_errors

- title: "Unit validation checks"
desc: "Unit validation checks. All return `hub_check` S3 class objects."
contents:
- starts_with("check_")

- title: "Optional unit validation checks"
desc: "Optional unit validation checks. All return `hub_check` S3 class objects and need to be deployed via `validations.yml` file."
contents:
- starts_with("opt_check_")


- title: "Lower level functions"
desc: "Lower level functions for assisting users in developing custom unit checks."
contents:
- starts_with("capture_")
- starts_with("is_")
- read_model_out_file
- try_check


- title: "`<hub_validations>` methods"
desc: "Methods for `<hub_validations>` S3 objects."
contents:
- starts_with("print")
- starts_with("combine")
- contains("hub_validations")
Loading