getTBinR (version 0.7.1)

get_tb_burden: Get the WHO TB Burden Data

Description

Get the TB burden data, and multi-drug resistant TB (MDR-TB) data from the WHO, see here for details. This function will first attempt to load the data from the temporary directory (tempdir). If that fails, and download_data = TRUE, it will instead download the data. The MDR TB data is only available for the latest year of data.

Usage

get_tb_burden(
  url = NULL,
  download_data = TRUE,
  save = TRUE,
  burden_save_name = NULL,
  add_mdr_data = TRUE,
  additional_datasets = NULL,
  mdr_save_name = NULL,
  mdr_url = NULL,
  return = TRUE,
  verbose = FALSE,
  use_utils = FALSE,
  retry_download = TRUE
)

Arguments

url

Character string, indicating the url of the TB burden data. Default is current url. This argument is depreciated and will be removed from future releases. The TB burden URL is now supplied internally - see available_datasets for details.

download_data

Logical, defaults to TRUE. If not found locally should the data be downloaded from the specified URL?

save

Logical, should the data be saved for reuse during the current R session. Defaults to TRUE. If TRUE then the data is saved to the temporary directory specified by tempdir.

burden_save_name

Character string, name to save the data under. This argument is depreciated and will be removed from future releases. Dataset naming is now handled internally.

add_mdr_data

Logical, defaults to TRUE. Should MDR TB burden data be downloaded and joined to the TB burden data.

additional_datasets

A character vector specifying the names of the additional datasets to import. See available_datasets for available datasets. Use "all" to download all available datasets (experimental datasets such as incidence by age and sex are excluded from this list).

mdr_save_name

Character string, name to save the MDR data under. This argument is depreciated and will be removed from future releases. Dataset naming is now handled internally.

mdr_url

Character string, indicating the url of the MDR TB data. This argument is depreciated and will be removed from future releases. The MDR-TB burden URL is now supplied internally - see available_datasets for details.

return

Logical, should the data be returned as a dataframe. Defaults to TRUE.

verbose

Logical, defaults to FALSE. Should additional status and progress messages be displayed.

use_utils

Logical, defaults to FALSE. Used for testing alternative data download function. When TRUE data is downloaded using read.csv.

retry_download

Logical defaults to TRUE. When TRUE, if downloading fails, the function will try repeatedly to download the data within 3 seconds, up to 3 times.

Value

The WHO TB burden data as a tibble.

See Also

get_data search_data_dict

Examples

# NOT RUN {

## Default datasets
tb_burden <- get_tb_burden(additional_datasets = available_datasets$dataset[3])

head(tb_burden)

## Add in the latent TB dataset as an additional dataset (see getTBinR::avaiable_datasets)
tb_with_latents <- get_tb_burden(additional_datasets = available_datasets$dataset[3])

head(tb_with_latents)
# }