Add custom function capabilitie to validate_model_metadata

R/validate_model_metadata.R

@@ -1,6 +1,6 @@
 #' Valid properties of a metadata file.
 #'
-#' @inheritParams check_tbl_colnames
+#' @inheritParams validate_model_file
 #' @return An object of class `hub_validations`. Each named element contains
 #' a `hub_check` class object reflecting the result of a given check. Function
 #' will return early if a check returns an error.
@@ -15,10 +15,14 @@
 #' validate_model_file(hub_path,
 #'   file_path = "team1-goodmodel.yml"
 #' )
-validate_model_metadata <- function(hub_path, file_path) {
+validate_model_metadata <- function(hub_path, file_path,
+                                    validations_cfg_path = NULL) {
   checks <- list()
   class(checks) <- c("hub_validations", "list")
 
+  file_meta <- parse_file_name(file_path)
+  round_id <- file_meta$round_id
+
   checks$metadata_schema_exists <- check_metadata_schema_exists(hub_path)
   if (is_error(checks$metadata_schema_exists)) {
     return(checks)
@@ -54,7 +58,9 @@ validate_model_metadata <- function(hub_path, file_path) {
     return(checks)
   }
 
-  # TODO: Add section for custom file checks
+  custom_checks <- execute_custom_checks(validations_cfg_path = validations_cfg_path)
+  checks <- c(checks, custom_checks)
+  class(checks) <- c("hub_validations", "list")
 
   checks
 }

vignettes/articles/custom-functions.Rmd

@@ -39,21 +39,22 @@ Within the default configuration, individual checks can be configured for each o
 Note that each of the `validate_*()` functions contain a standard objects in their call environment which are passed automatically to any custom check function and therefore do not need including in the `args` configuration. 
 
 - **`validate_model_file`:**
-  - `file_path`
-  - `hub_path`
-  - `round_id`
-  - `file_meta`
+  - `file_path`: character string of path to file being validated relative to the `model-output` directory.
+  - `hub_path`: character string of path to hub.
+  - `round_id`: character string of `round_id`
+  - `file_meta`: named list containing `round_id`, `team_abbr`, `model_abbr` and `model_id` details.
 - **`validate_model_data`:** 
-  - `tbl`
-  - `file_path`
-  - `hub_path`
-  - `round_id`
-  - `file_meta`
-  - `round_id_col`
-- **`validate_model_data`:** 
-  - `file_path`
-  - `hub_path`
-  - `round_id`
+  - `tbl`: a tibble of the model output data being validated.
+  - `file_path`: character string of path to file being validated relative to the `model-output` directory.
+  - `hub_path`: character string of path to hub.
+  - `round_id`: character string of `round_id`
+  - `file_meta`: named list containing `round_id`, `team_abbr`, `model_abbr` and `model_id` details.
+  - `round_id_col`: character string of name of `tbl` column containing `round_id` information.
+- **`validate_model_metadata`:** 
+  - `file_path`: character string of path to file being validated relative to the `model-output` directory.
+  - `hub_path`: character string of path to hub.
+  - `round_id`: character string of `round_id`
+  - `file_meta`: named list containing `round_id`, `team_abbr`, `model_abbr` and `model_id` details.
 
 The `args` configuration can be used to override objects from the caller environment.