_pkgdown.yml

url: https://hubverse-org.github.io/hubValidations/
template:
  bootstrap: 5
  package: hubStyle

reference:
- title: "Utilities for submitting teams"
  desc: "Functions to help teams create valid submission model output files."
  contents:
  - validate_submission
  - submission_tmpl
  - create_hub_schema
  - coerce_to_hub_schema

- 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: "Custom unit validation checks"
  desc: "Functions to support creation and deployment of custom unit validation checks"
  contents:
  - create_custom_check

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


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

navbar:
 components:
   articles:
    text: Articles
    menu:
    - text: Structure of hub_validations class objects
      href: articles/hub-validations-class.html
    - text: -------
    - text: "Validation for hub admins through CI"
    - text: Validating Pull Requests on GitHub
      href: articles/validate-pr.html
    - text: -------
    - text: "Validation for submitting teams"
    - text: Validating submissions locally
      href: articles/validate-submission.html
    - text: -------
    - text: "Custom validation checks"
    - text: Writing custom validation functions
      href: articles/writing-custom-fns.html
    - text: Deploying custom validation functions
      href: articles/deploying-custom-functions.html
development:
  mode: auto