porowhitahauwha

porowhitahauwha

The goal of porowhitahauwha is to provide a code-based interface for staff at Auckland Council to work with the Porowhita Hauwhā database.

The Porowhita Hauwhā database can be thought of as a quadrant of information: it contains data about staff, partners, buildings, andservices that fall within the remit of the Connected Communities department at Te Kunihera o Tāmaki Makaurau (Auckland Council).

Porowhita hauwhā is a kupu (word) in te Reo Māori which means “quadrant”.

Installation

You can install the development version of porowhitahauwha from GitHub with:

# install.packages("devtools")
devtools::install_github("Auckland-Council-CC-Insights-Team/porowhitahauwha")

Example

This is a basic example which shows you how to retrieve a list of all asset-type facilities from the test database that is provided with the package:

library(porowhitahauwha)
get_assets(test_db = TRUE)
#> # A tibble: 2 × 9
#>   facility_id name         physi…¹ local…² desig…³ deliv…⁴ facil…⁵ closed leased
#>   <chr>       <chr>        <chr>   <chr>   <chr>   <chr>   <chr>   <lgl>  <lgl> 
#> 1 A26         Buckland Co… Cnr Lo… Frankl… Rural … Commun… Privat… FALSE  FALSE 
#> 2 A58         Franklin Th… 12 Mas… Frankl… Hybrid  Counci… <NA>    NA     NA    
#> # … with abbreviated variable names ¹​physical_address, ²​local_board,
#> #   ³​designation, ⁴​delivery_model, ⁵​facility_ownership

A vignette is being written that will explain the conceptual framework that was designed to inform how the data was modeled. This will define, in technical parlance, what is an asset, a space, an entity, and how the three are related.

Terms of use

Only authorised kaimahi at Auckland Council are able to access the production database for which this package provides a code-based interface, but anyone can freely use and adapt the code contained in this package for their own purposes.

This package comes bundled with test data, which anyone can access and use as they see fit. The test data only features data that is already publicly available elsewhere, and any information about real individuals has been replaced with fake data. You may find the help files for test data tables useful if you are tasked with modelling similar data, for example in local government.