readabs (version 0.4.3)

read_abs: Download, extract, and tidy ABS time series spreadsheets

Description

read_abs() downloads ABS time series spreadsheets, then extracts the data from those spreadsheets, then tidies the data. The result is a single data frame (tibble) containing tidied data.

Usage

read_abs(
  cat_no = NULL,
  tables = "all",
  series_id = NULL,
  path = Sys.getenv("R_READABS_PATH", unset = tempdir()),
  metadata = TRUE,
  show_progress_bars = TRUE,
  retain_files = TRUE,
  check_local = TRUE
)

Arguments

cat_no

ABS catalogue number, as a string, including the extension. For example, "6202.0".

tables

numeric. Time series tables in `cat_no`` to download and extract. Default is "all", which will read all time series in `cat_no`. Specify `tables` to download and import specific tables(s) - eg. `tables = 1` or `tables = c(1, 5)`.

series_id

(optional) character. Supply an ABS unique time series identifier (such as "A2325807L") to get only that series. This is an alternative to specifying `cat_no`.

path

Local directory in which downloaded ABS time series spreadsheets should be stored. By default, `path` takes the value set in the environment variable "R_READABS_PATH". If this variable is not set, any files downloaded by read_abs() will be stored in a temporary directory (tempdir()). See Details below for more information.

metadata

logical. If `TRUE` (the default), a tidy data frame including ABS metadata (series name, table name, etc.) is included in the output. If `FALSE`, metadata is dropped.

show_progress_bars

TRUE by default. If set to FALSE, progress bars will not be shown when ABS spreadsheets are downloading.

retain_files

when TRUE (the default), the spreadsheets downloaded from the ABS website will be saved in the directory specified with `path`. If set to `FALSE`, the files will be stored in a temporary directory.

check_local

If `TRUE`, the default, local `fst` files are used, if present.

Value

A data frame (tibble) containing the tidied data from the ABS time series table(s).

Details

`read_abs()` downloads spreadsheet(s) from the ABS containing time series data. These files need to be saved somewhere on your disk. This local directory can be controlled using the `path` argument to `read_abs()`. If the `path` argument is not set, `read_abs()` will store the files in a directory set in the "R_READABS_PATH" environment variable. If this variable isn't set, files will be saved in a temporary directory.

To check the value of the "R_READABS_PATH" variable, run Sys.getenv("R_READABS_PATH"). You can set the value of this variable for a single session using Sys.setenv(R_READABS_PATH = <path>). If you would like to change this variable for all future R sessions, edit your `.Renviron` file and add R_READABS_PATH = <path> line. The easiest way to edit this file is using usethis::edit_r_environ().

Examples

# NOT RUN {
# Download and tidy all time series spreadsheets
# from the Wage Price Index (6345.0)

# }
# NOT RUN {
wpi <- read_abs("6345.0")
# }
# NOT RUN {
# Get two specific time series, based on their time series IDs

# }
# NOT RUN {
cpi <- read_abs(series_id = c("A2325806K", "A2325807L"))
# }
# NOT RUN {
# }