#' Get the WHO Data Dictionary for TB Data
#'
#' @description Get the data dictionary for TB burden data from the WHO, see
#' [here](http://www.who.int/tb/country/data/download/en/) for details. This function will first attempt
#' to load the data from the temporary directory (\code{\link[base]{tempdir}}). If that fails, and \code{download_data = TRUE}, it
#' will instead download the data.
#'
#' @param url Character string, indicating the url of the data
#' dictionary. This argument is depreciated and will be removed from future releases.
#' @param dict_save_name Character string, name to save dictionary under. This argument is depreciated
#' and will be removed from future releases. Dataset naming is now handled internally.
#' @param return Logical, should the data dictionary be returned as a dataframe.
#' Defaults to \code{TRUE}.
#' @inheritParams get_data
#' @return The WHO TB data dictionary as a tibble with 4 variables:
#' variable_name, dataset, code_list, definition.
#' @export
#' @seealso get_data search_data_dict
#' @examples
#'
#' dict <- get_data_dict()
#'
#' head(dict)
get_data_dict <- function(url = NULL,
download_data = TRUE,
save = TRUE,
dict_save_name = NULL,
return = TRUE,
verbose = FALSE,
use_utils = FALSE,
retry_download = TRUE) {
if (!is.null(url)) {
warning("This argument is depreciated and will be removed from future releases.
The URL is now supplied internally.")
} else {
url <- "https://extranet.who.int/tme/generateCSV.asp?ds=dictionary"
}
if (!is.null(dict_save_name)) {
warning("This argument is depreciated and will be removed from future releases.
The dataset savename is now supplied internally.")
} else {
dict_save_name <- "dictionary"
}
get_data(
url = url,
download_data = download_data,
save = save,
save_name = dict_save_name,
return = return,
verbose = verbose,
use_utils = use_utils
)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.