readabs (version 0.4.8)

download_abs_data_cube: Experimental helper function to download ABS data cubes that are not compatible with read_abs.

Description

download_abs_data_cube() downloads the latest ABS data cubes based on the catalogue name (from the new website url) and cube. The function downloads the file to disk. In comparison to read_abs() this function doesn't tidy the data.

Usage

download_abs_data_cube(
  catalogue_string,
  cube,
  path = Sys.getenv("R_READABS_PATH", unset = tempdir())
)

Arguments

catalogue_string

ABS catalogue name as a string from the new website. For example, Labour Force, Australia, Detailed is "labour-force-australia-detailed". The possible catalogues can be obtained using the helper function show_available_catalogues()

cube

character. A character string that is either the complete filename or (uniquely) in the filename of the data cube you want to download, e.g. "EQ09". #' The available filenames can be obtained using the helper function get_available_filenames()

path

Local directory in which downloaded files 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.

Details

`download_abs_data_cube()` downloads a file from the ABS containing a data cube. 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().

The filepath is returned invisibly which enables piping to unzip() or readxl::read_excel.

Examples

# NOT RUN {
# }
# NOT RUN {
download_abs_data_cube(
  catalogue_string = "labour-force-australia-detailed",
  cube = "EQ09"
)
# }
# NOT RUN {
# }