add documentation

Public-Health-Scotland · May 13, 2024 · a0f153e · a0f153e
1 parent d76c1c5
commit a0f153e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -4,4 +4,5 @@ export(get_dataset)
 export(get_resource)
 export(get_resource_sql)
 export(show_datasets)
+export(show_resources)
 importFrom(magrittr,"%>%")
diff --git a/R/show_resources.R b/R/show_resources.R
@@ -1,5 +1,8 @@
 #' Show all available resources for a dataset
 #'
+#' show_resources() returns all of the resources associated
+#' with a dataset
+#'
 #' @param dataset_name
 #'
 #' @return a [tibble][tibble::tibble-package] with the data