read_absmap: Read ABS geographic data

View source: R/read_absmaps.R

read_absmapR Documentation

Read ABS geographic data

Description

Read ABS geographic data as sf objects from the [absmapsdata](https://github.com/wfmackey/absmapsdata) package.

Arguments

name

a character string containing absmapsdata file names in [area][year] format, eg "sa42016"; "gcc2021". See full list at https://github.com/wfmackey/absmapsdata. Note: if name is entered, then area and year values will be ignored.

area

a character string containing the concise absmapsdata area names, eg "sa4"; "gcc". See full list at https://github.com/wfmackey/absmapsdata.

year

a character string or numeric of the full source year of absmapsdata object, eg "2016"; 2021. See full list at https://github.com/wfmackey/absmapsdata.

remove_year_suffix

logical defaulting to FALSE. If TRUE, 'strip_year_suffix' is run before returning the object, removing the '_year' suffix from variable names.

export_dir

path to a directory to store the desired sf object. tempdir() by default.

.validate_name

logical defaulting to TRUE, which checks the name input (or area year combination) against a list of available objects in the absmapsdata package.

Value

an sf object.

See Also

https://github.com/wfmackey/absmapsdata

Examples


## Not run: read_absmap("sa42016")

## Not run: read_absmap(area = "sa4", year = 2016)


runapp-aus/abscorr documentation built on Oct. 15, 2024, 2:18 p.m.