Skip to content

carlosyanez/aussiemaps

Repository files navigation

Lifecycle: experimental R-CMD-checkaussiemaps status badge

aussiemaps

aussiemaps provides maps for Australian LGA, suburbs, Postal Area maps, SA1/2/3/4, etc. - directly in R, without any need to download and process shapefiles.

All the data is contained as a release (here) in Apache Parquet format, so it can be used directly in any programming language/tool/platform that supports Parquet.

Installation

You can install this package from Github

remotes::install_github("carlosyanez/aussiemaps")

Alternatively, install from r-universe


# Enable this universe
options(repos = c(
    carlosyanez = 'https://carlosyanez.r-universe.dev',
    CRAN = 'https://cloud.r-project.org'))

# Install some packages
install.packages('aussiemaps')

How to use

Read the vignette.

Please note that no data is included in the package installation - data files will be downloaded and cached as needed.

DISCLAIMER

THE DATA IN THIS FILE IS PROVIDED WITHOUT ANY GUARANTEES. USE AT YOUR OWN RISK!

If you detect any issues in the resulting maps, please submit an issue in the Github repository. Please don't use this package or its data for any mission critical/important withouth reviewing its adequacy.

Not for you?

The development of this package is still in progress.It also intends to provide granular suburb/postal area maps, so it may not be suitable for some use cases. There are other great Australian maps packages, such as:

  • ozmaps, which has good nation-wide, states and LGA maps, as well as electoral divisions. This package is on CRAN.
  • absmapsdata, which provides maps for all ABS statistical divisions.
  • You can always download the gpkg files from the ABS or https://data.gov.au .

Issues? bugs? Ideas?

If you find something that is not quite right, please post an issue. If you have any ideas, or if you want to contribute, please let me know!

To Do

At the moment, this package only provides maps for internal states and territories.

Credits

Acknowledgment of Country

The author of this package acknowledges the Aboriginal and Torres Strait Islander people as the traditional custodians of Australia, and pays respect to their Elders past, present and emerging.