load_absmaps: Download and load ABS ASGS shapefile data, compress and save...

Description Usage Arguments Value Examples

View source: R/load_absmaps.R

Description

Download and load ABS ASGS shapefile data, compress and save as an sf object.

Usage

1
2
load_absmaps(area, year = 2016, saveDirectory, download = TRUE,
  mapCompression = 0.1, removeSourceFiles = TRUE)

Arguments

area

The area you want to download/convert/compress. One of: "sa1", "sa2, "sa3", "sa4", "gcc", "state", "ra" (remoteness area), "mesh_[STATE]" (eg mesh_nsw, mesh_tas, mesh_wa), "indigenous_locations", "indigenous_area", "indigenous_regions", "ced" (Commonwealth electoral district), "sed" (State electoral district), "lga" (local government area)

year

The year of the ASGS data. Defaults to 2016, but 2011 will be useful for older data.

saveDirectory

The existing path to which your map data is saved. Default is the current working directory.

download

Download ASGS data from the ABS. Default is TRUE. Set to FALSE if data are already downloaded and compressed.

mapCompression

The compression level of your map data. Default is 0.1 – 10 per cent of original detail – which makes clear, detailed maps. Higher compression leads to greater map file size with, in most cases, little visual benefit. Map compression can be set to "off".

removeSourceFiles

Remove the original ABS shapefile data after compression. Defaults to TRUE.

Value

A sf object containing statistical area name, number and geometry; the size of the area; and higher-level statistical areas (eg the state and gcc of an sa2).

Examples

1
2
3
4
## Not run: 
staes <- load_absmaps("state", 2016, saveDirectory = "data")

## End(Not run)

wfmackey/absmaps documentation built on Oct. 4, 2021, 8:23 p.m.