Add usecase, statement of need and longer description

rOpenGov · Nov 17, 2024 · e916a36 · e916a36
1 parent 24eab13
commit e916a36
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/R/dst_get_all_data.R b/R/dst_get_all_data.R
@@ -1,7 +1,12 @@
 #' This function returns the entire table requested data from the StatBank.
 #' (http://www.statistikbanken.dk/statbank5a/ or http://www.dst.dk)
 #'
-#' Get all data from a table in the StatBank.
+#' @description Get all data from a table in the StatBank. This function
+#'   provides all the query parameters on the user's behalf. You, as a user, do
+#'   not need to specify anything other than a table name and you will be given
+#'   the entire contents of the table in a nice long format. This is useful for
+#'   you, if you would like to filter the table with e.g. `{dplyr}` functions or
+#'   save the entire table for archival.
 #'
 #' @export
 #' @inheritParams dst_get_data

diff --git a/man/dst_get_all_data.Rd b/man/dst_get_all_data.Rd