Docs updates and routine maintenance

Author: arcresu

DESCRIPTION

@@ -27,6 +27,7 @@ Imports:
 Suggests: 
     dplyr (>= 1.0.0),
     ggplot2,
+    httr2,
     nngeo,
     readr,
     stringr

LICENSE

@@ -1,2 +1,2 @@
-YEAR: 2022
+YEAR: 2024
 COPYRIGHT HOLDER: Western Sydney Local Health District, NSW Health

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2022 Western Sydney Local Health District, NSW Health
+Copyright (c) 2022-2024 Western Sydney Local Health District, NSW Health
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

R/utils.R

@@ -23,8 +23,11 @@
 #' @examples
 #' normalise_state_names(c("nsw", "VIC", "overseas", "Queensland"))
 normalise_state_names <- function(names) {
-  cartographer::resolve_feature_names(names, feature_type = "nswgeo.states",
-                                      unmatched = "pass")
+  cartographer::resolve_feature_names(
+    names,
+    feature_type = "nswgeo.states",
+    unmatched = "pass"
+  )
 }
 
 #' Normalise postal codes

README.Rmd

@@ -27,8 +27,7 @@ set.seed(2022)
 <!-- badges: end -->
 
 A collection of geospatial datasets and map plotting helpers for working
-with New South Wales maps. The maps are registered with `{cartographer}` and so
-are compatible with `{ggautomap}`.
+with New South Wales maps. The maps are registered with `{cartographer}`.
 
 ## Installation
 
@@ -68,3 +67,19 @@ covid_cases_nsw |>
   theme_void()
 ```
 
+## A note on resolution
+
+Some of the source datasets are very high resolution and would make this package
+too large if they were bundled. Accordingly, most data has been processed to
+reduce the resolution. You can see exactly what was done by looking at the
+scripts in `data-raw/`.
+
+If you need higher resolution shapes, such as when zooming into specific postal
+areas, you're better off using the original datasets directly.
+
+## Other Australian data
+
+  * [`strayr`](https://runapp-aus.github.io/strayr/) helps with working with
+    data from the Australian Bureau of Statistics (ABS).
+  * [`absmapsdata`](https://github.com/wfmackey/absmapsdata) contains some
+    processed ABS geospatial data.

README.md

@@ -13,8 +13,8 @@ status](https://www.r-pkg.org/badges/version/nswgeo)](https://CRAN.R-project.org
 <!-- badges: end -->
 
 A collection of geospatial datasets and map plotting helpers for working
-with New South Wales maps. The maps are registered with `{cartographer}`
-and so are compatible with `{ggautomap}`.
+with New South Wales maps. The maps are registered with
+`{cartographer}`.
 
 ## Installation
 
@@ -66,3 +66,20 @@ covid_cases_nsw |>
 ```
 
 <img src="man/figures/README-cartographer-1.png" width="100%" />
+
+## A note on resolution
+
+Some of the source datasets are very high resolution and would make this
+package too large if they were bundled. Accordingly, most data has been
+processed to reduce the resolution. You can see exactly what was done by
+looking at the scripts in `data-raw/`.
+
+If you need higher resolution shapes, such as when zooming into specific
+postal areas, you’re better off using the original datasets directly.
+
+## Other Australian data
+
+- [`strayr`](https://runapp-aus.github.io/strayr/) helps with working
+  with data from the Australian Bureau of Statistics (ABS).
+- [`absmapsdata`](https://github.com/wfmackey/absmapsdata) contains some
+  processed ABS geospatial data.

_pkgdown.yml

@@ -1,4 +1,34 @@
 url: https://cidm-ph.github.io/nswgeo/
 template:
   bootstrap: 5
+  bootswatch: journal
+  theme: solarized-light
 
+reference:
+- title: Map data
+  desc: >
+    Map data included with the package. This is normally a low resolution version
+    of the original data. Intended for use with `sf`.
+  contents:
+  - australia
+  - lhd
+  - lga_nsw
+  - nsw
+  - phn
+- title: Tabular spatial data
+  contents:
+  - poa_lhd_concordance
+  - postcodes
+  - suburbs
+- title: Mapping helpers
+  contents:
+  - crs_gda2020
+  - outline
+- title: Data cleaning
+  contents:
+  - normalise_postcodes
+  - normalise_state_names
+- title: Package
+  contents:
+  - nswgeo-package
+  - covid_cases_nsw

man/figures/README-cartographer-1.png

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: 029eac82-151e-4850-a618-8000c1c02aee
 
 RestoreWorkspace: No
 SaveWorkspace: No