diff --git a/R/dst_correct_url.R b/R/dst_correct_url.R index 60d4cf1..9f1dc81 100644 --- a/R/dst_correct_url.R +++ b/R/dst_correct_url.R @@ -1,6 +1,7 @@ #' Corrects url encoding for Danish letters. #' #' @param url A build url. +#' @noRd dst_correct_url <- function(url) { url <- stringr::str_replace_all( string = url, diff --git a/R/dst_date_parse.R b/R/dst_date_parse.R index 93ec47a..c97298c 100644 --- a/R/dst_date_parse.R +++ b/R/dst_date_parse.R @@ -3,6 +3,7 @@ #' @param dst_date A vector of length one or more with date formats like #' 1982M12D09, 1982M12, 1982Q4 or 1982 #' @returns Returns the input date formatted to be Europe/Copenhagen +#' @noRd dst_date_parse <- function(dst_date) { tz <- "Europe/Copenhagen" diff --git a/R/dst_find_val_id.R b/R/dst_find_val_id.R index ce7b79d..7730e66 100644 --- a/R/dst_find_val_id.R +++ b/R/dst_find_val_id.R @@ -5,6 +5,7 @@ #' @param variable The variable to search in. #' @param values_text Character vector. The values you want to extract the IDs #' for. If NULL, the returned value will be "*". +#' @noRd dst_find_val_id <- function(meta_data, variable, values_text = NULL) { names(meta_data$values) <- toupper(names(meta_data$values)) diff --git a/R/dst_meta_parse.R b/R/dst_meta_parse.R index 58e7c5c..3bcfa5b 100644 --- a/R/dst_meta_parse.R +++ b/R/dst_meta_parse.R @@ -9,6 +9,7 @@ #' @param meta The returned meta data from the function meta_dst. #' @param lang The language from the orignal dst_meta function (due to an error #' in the API) +#' @noRd dst_meta_parse <- function(meta, lang) { # Get basic info on the table. # The basics contains a description on what diff --git a/R/dst_query_match.R b/R/dst_query_match.R index 0268f94..9a65c4f 100644 --- a/R/dst_query_match.R +++ b/R/dst_query_match.R @@ -7,6 +7,7 @@ #' @param query query to match against #' @param format Format to specify match for csv import (not used) #' +#' @noRd dst_query_match <- function(table, lang, meta_data, query, format) { # if no meta data is supplied we download this to match the request. if (is.null(meta_data)) { diff --git a/R/dst_value_limit.R b/R/dst_value_limit.R index a5d5d13..3c35520 100644 --- a/R/dst_value_limit.R +++ b/R/dst_value_limit.R @@ -4,6 +4,7 @@ #' #' @param query Query object to analyse #' @param dst_meta Meta data to filer query with +#' @noRd dst_value_limit <- function(query, dst_meta) { # is the element in the list a "*"? is_star <- lapply(query, function(x) { diff --git a/man/dst_correct_url.Rd b/man/dst_correct_url.Rd deleted file mode 100644 index 560af32..0000000 --- a/man/dst_correct_url.Rd +++ /dev/null @@ -1,14 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dst_correct_url.R -\name{dst_correct_url} -\alias{dst_correct_url} -\title{Corrects url encoding for Danish letters.} -\usage{ -dst_correct_url(url) -} -\arguments{ -\item{url}{A build url.} -} -\description{ -Corrects url encoding for Danish letters. -} diff --git a/man/dst_date_parse.Rd b/man/dst_date_parse.Rd deleted file mode 100644 index ba45969..0000000 --- a/man/dst_date_parse.Rd +++ /dev/null @@ -1,18 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dst_date_parse.R -\name{dst_date_parse} -\alias{dst_date_parse} -\title{Helper function to parse the dates from the statbank.} -\usage{ -dst_date_parse(dst_date) -} -\arguments{ -\item{dst_date}{A vector of length one or more with date formats like -1982M12D09, 1982M12, 1982Q4 or 1982} -} -\value{ -Returns the input date formatted to be Europe/Copenhagen -} -\description{ -Helper function to parse the dates from the statbank. -} diff --git a/man/dst_find_val_id.Rd b/man/dst_find_val_id.Rd deleted file mode 100644 index 13b9e7f..0000000 --- a/man/dst_find_val_id.Rd +++ /dev/null @@ -1,21 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dst_find_val_id.R -\name{dst_find_val_id} -\alias{dst_find_val_id} -\title{This is a helper function to extract the ID's in the values list that the -dst_meta function returns.} -\usage{ -dst_find_val_id(meta_data, variable, values_text = NULL) -} -\arguments{ -\item{meta_data}{The meta data object.} - -\item{variable}{The variable to search in.} - -\item{values_text}{Character vector. The values you want to extract the IDs -for. If NULL, the returned value will be "*".} -} -\description{ -This is a helper function to extract the ID's in the values list that the -dst_meta function returns. -} diff --git a/man/dst_meta_parse.Rd b/man/dst_meta_parse.Rd deleted file mode 100644 index b924232..0000000 --- a/man/dst_meta_parse.Rd +++ /dev/null @@ -1,21 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dst_meta_parse.R -\name{dst_meta_parse} -\alias{dst_meta_parse} -\title{This function parses the JSON from the StatBank. -(http://www.statistikbanken.dk/statbank5a/ or http://www.dst.dk)} -\usage{ -dst_meta_parse(meta, lang) -} -\arguments{ -\item{meta}{The returned meta data from the function meta_dst.} - -\item{lang}{The language from the orignal dst_meta function (due to an error -in the API)} -} -\description{ -This function structures the JSON data a bit an creates a basic_query. Some -tables are VERY large, so the basic request is rather simple. The function -returns a list with basic data, info on available variables and a list with a -basic request. -} diff --git a/man/dst_query_match.Rd b/man/dst_query_match.Rd deleted file mode 100644 index 3bdfc6b..0000000 --- a/man/dst_query_match.Rd +++ /dev/null @@ -1,22 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dst_query_match.R -\name{dst_query_match} -\alias{dst_query_match} -\title{Helper function to return ids based on text values} -\usage{ -dst_query_match(table, lang, meta_data, query, format) -} -\arguments{ -\item{table}{Table from StatBank.} - -\item{lang}{language. "en" for english and "da" for danish.} - -\item{meta_data}{A meta data object to extract values from} - -\item{query}{query to match against} - -\item{format}{Format to specify match for csv import (not used)} -} -\description{ -This is a helper function to return the ids based on the text values. -} diff --git a/man/dst_value_limit.Rd b/man/dst_value_limit.Rd deleted file mode 100644 index fddaa4c..0000000 --- a/man/dst_value_limit.Rd +++ /dev/null @@ -1,20 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/dst_value_limit.R -\name{dst_value_limit} -\alias{dst_value_limit} -\title{This is a helper function that returns the number -of values the call will return. -The API has a limit of 100.000 values.} -\usage{ -dst_value_limit(query, dst_meta) -} -\arguments{ -\item{query}{Query object to analyse} - -\item{dst_meta}{Meta data to filer query with} -} -\description{ -This is a helper function that returns the number -of values the call will return. -The API has a limit of 100.000 values. -}