From e33db323bd380e98ebe993bed8deb15a29de844e Mon Sep 17 00:00:00 2001 From: aleksanderbl29 <73799306+aleksanderbl29@users.noreply.github.com> Date: Wed, 27 Nov 2024 23:07:37 +0100 Subject: [PATCH] Enable roxygen markdown --- DESCRIPTION | 2 +- R/dst_get_all_data.R | 2 +- man/dst_get_all_data.Rd | 12 ++++++------ man/tables_da.Rd | 20 +++++++++++--------- man/tables_en.Rd | 20 +++++++++++--------- 5 files changed, 30 insertions(+), 26 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 67168a3..ac86d4b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -24,7 +24,7 @@ Imports: Suggests: testthat Encoding: UTF-8 -Roxygen: list(wrap = FALSE) +Roxygen: list(markdown = TRUE) RoxygenNote: 7.3.2 X-schema.org-isPartOf: http://ropengov.org/ X-schema.org-keywords: ropengov diff --git a/R/dst_get_all_data.R b/R/dst_get_all_data.R index e0fe14f..7fc197a 100644 --- a/R/dst_get_all_data.R +++ b/R/dst_get_all_data.R @@ -5,7 +5,7 @@ #' 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 +#' you, if you would like to filter the table with e.g. `{dplyr}` functions or #' save the entire table for archival. #' #' @export diff --git a/man/dst_get_all_data.Rd b/man/dst_get_all_data.Rd index 298b2fc..d8439ff 100644 --- a/man/dst_get_all_data.Rd +++ b/man/dst_get_all_data.Rd @@ -17,17 +17,17 @@ day of the period and the time zone is "UTC" and not the Danish "CET".} } \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. +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. \code{{dplyr}} functions or +save the entire table for archival. } \seealso{ Other Data retrival functions: \code{\link{dst_get_data}()} } \author{ -Aleksander Bang-Larsen +Aleksander Bang-Larsen \href{mailto:contact@aleksanderbl.dk}{contact@aleksanderbl.dk} } \concept{Data retrival functions} diff --git a/man/tables_da.Rd b/man/tables_da.Rd index 66ed8c1..652d86e 100644 --- a/man/tables_da.Rd +++ b/man/tables_da.Rd @@ -5,17 +5,19 @@ \alias{tables_da} \title{Cached list of all available tables with danish names and descriptions} \format{ -## `tables_da` +\subsection{\code{tables_da}}{ + A data frame with 2339 rows and 8 columns: \describe{ - \item{id}{Unique ID of the table} - \item{text}{Description of the table} - \item{unit}{The unit of the values represented in the table} - \item{updated}{When this table was last updated} - \item{firstPeriod}{The time of the first observation in the table} - \item{latestPeriod}{The time of the latest observation in the table} - \item{active}{Binary indicator of the table being active} - \item{variables}{List of the variables in the table} +\item{id}{Unique ID of the table} +\item{text}{Description of the table} +\item{unit}{The unit of the values represented in the table} +\item{updated}{When this table was last updated} +\item{firstPeriod}{The time of the first observation in the table} +\item{latestPeriod}{The time of the latest observation in the table} +\item{active}{Binary indicator of the table being active} +\item{variables}{List of the variables in the table} +} } } \usage{ diff --git a/man/tables_en.Rd b/man/tables_en.Rd index c8d97c4..58be65d 100644 --- a/man/tables_en.Rd +++ b/man/tables_en.Rd @@ -5,17 +5,19 @@ \alias{tables_en} \title{Cached list of all available tables} \format{ -## `tables_en` +\subsection{\code{tables_en}}{ + A data frame with 2339 rows and 8 columns: \describe{ - \item{id}{Unique ID of the table} - \item{text}{Description of the table} - \item{unit}{The unit of the values represented in the table} - \item{updated}{When this table was last updated} - \item{firstPeriod}{The time of the first observation in the table} - \item{latestPeriod}{The time of the latest observation in the table} - \item{active}{Binary indicator of the table being active} - \item{variables}{List of the variables in the table} +\item{id}{Unique ID of the table} +\item{text}{Description of the table} +\item{unit}{The unit of the values represented in the table} +\item{updated}{When this table was last updated} +\item{firstPeriod}{The time of the first observation in the table} +\item{latestPeriod}{The time of the latest observation in the table} +\item{active}{Binary indicator of the table being active} +\item{variables}{List of the variables in the table} +} } } \usage{