read_apra {readapra}R Documentation

Read APRA's Statistical Publications

Description

Download and import a specific statistical publication produced by APRA.

Please consult the apra_stat_pubs dataset to see which of APRA's statistical publications are available in readapra.

Usage

read_apra(
  stat_pub,
  cur_hist = "current",
  path = tempdir(),
  quiet = FALSE,
  overwrite = TRUE,
  ...
)

Arguments

stat_pub

character vector detailing a statistical publication to be downloaded and imported. Must match a valid value in the apra_stat_pubs_acronym variable of the apra_stat_pubs dataset.

cur_hist

character vector detailing whether to download and import a current or historic statistical publication. Must match a valid value in the cur_hist variable of the apra_stat_pubs dataset.

path

path to where the downloaded file should be saved. Uses base::tempdir() by default.

quiet

whether to suppress the download progress bar.

overwrite

whether to overwrite a previously downloaded statistical publication file when re-running this function.

...

additional arguments to be passed to utils::download.file().

Value

A tibble containing the statistical publication data.

Examples


# Download and import the current MADIS data:
current_madis_data <-
  read_apra(stat_pub = "madis", cur_hist = "current")

# Examine the current MADIS data:
print(current_madis_data)



[Package readapra version 0.2.1 Index]