export validation function (#75)

NAMESPACE

@@ -114,6 +114,7 @@ export(set_keys)
 export(teal_data)
 export(teal_data_file)
 export(to_relational_data)
+export(validate_metadata)
 import(shiny)
 importFrom(digest,digest)
 importFrom(formatters,var_labels)

NEWS.md

@@ -1,5 +1,7 @@
 # teal.data 0.1.1.9001
 
+* Exported `validate_metadata` function.
+
 # teal.data 0.1.1
 
 ### Miscellaneous

R/utils.R

@@ -119,10 +119,23 @@ check_pkg_quietly <- function(pckg, msg) {
   invisible(NULL)
 }
 
-# validate metadata as a list of length one atomic
+
+#' validate metadata as a list of length one atomic entries (or NULL)
+#' @param metadata `object` to be checked
+#' @return `NULL` or throw error
+#' @examples
+#'
+#' validate_metadata(NULL)
+#' validate_metadata(list(A = TRUE, B = 10, C = "test"))
+#' \dontrun{
+#' validate_metadata(list(a = 1:10))
+#' }
+#'
+#' @export
 validate_metadata <- function(metadata) {
   checkmate::assert_list(metadata, any.missing = FALSE, names = "named", null.ok = TRUE)
   lapply(names(metadata), function(name) {
     checkmate::assert_atomic(metadata[[name]], len = 1, .var.name = name)
   })
+  return(NULL)
 }

_pkgdown.yml

@@ -86,6 +86,7 @@ reference:
       - join_keys
       - python_code
       - read_script
+      - validate_metadata
   - title: For Developers
     subtitle: R6 Classes
     desc: Abstract and concrete classes used to build teal functionality.