diff --git a/R/dst_get_all_data.R b/R/dst_get_all_data.R index 9139dc8..78e6faf 100644 --- 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 index 68f2ea5..ee273ac 100644 --- a/man/dst_get_all_data.Rd +++ b/man/dst_get_all_data.Rd @@ -13,7 +13,12 @@ dst_get_all_data(table, lang = "da") \item{lang}{language. "en" for english or "da" for danish.} } \description{ -Get all data from a table in the StatBank. +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. } \seealso{ Other Data retrival functions: