porowhitahauwha

Interact With Data About Facilities And Partners Within The Connected Communities Portfolio

https://github.com/auckland-council-cc-insights-team/porowhitahauwha

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (17.5%) to scientific vocabulary

Last synced: 7 months ago · JSON representation ·

Repository

Interact With Data About Facilities And Partners Within The Connected Communities Portfolio

Basic Info

Host: GitHub
Owner: Auckland-Council-CC-Insights-Team
License: other
Language: R
Default Branch: master
Homepage: https://auckland-council-cc-insights-team.github.io/porowhitahauwha/
Size: 256 KB

Statistics

Stars: 1
Watchers: 1
Forks: 0
Open Issues: 12
Releases: 0

Created over 3 years ago · Last pushed 10 months ago

Metadata Files

Readme License Citation

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# porowhitahauwha


[![R-CMD-check](https://github.com/Auckland-Council-CC-Insights-Team/porowhitahauwha/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/Auckland-Council-CC-Insights-Team/porowhitahauwha/actions/workflows/R-CMD-check.yaml)
[![test-coverage](https://github.com/Auckland-Council-CC-Insights-Team/porowhitahauwha/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/Auckland-Council-CC-Insights-Team/porowhitahauwha/actions/workflows/test-coverage.yaml)


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](https://github.com/) with:

``` r
# 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:

```{r example}
library(porowhitahauwha)
get_assets(test_db = TRUE)
```

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.

Owner

Name: Auckland-Council-CC-Insights-Team
Login: Auckland-Council-CC-Insights-Team
Kind: organization
Location: New Zealand

Repositories: 3
Profile: https://github.com/Auckland-Council-CC-Insights-Team

Citation (CITATION.cff)

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.2.3
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "porowhitahauwha" in publications use:'
type: software
license: MIT
title: 'porowhitahauwha: Interact With Data About Facilities and Partners Within the
  Connected Communities Portfolio'
version: 0.0.0.9000
abstract: This package allows authorised staff at Auckland Council to read from and
  write to Porowhita Hauwhā, a database that stores information about facilities,
  partners, and related data that falls within the Connected Communities portfolio.
authors:
- family-names: Durbin
  given-names: Lee
  email: lee.durbin@aucklandcouncil.govt.nz
preferred-citation:
  type: manual
  title: 'porowhitahauwha: Interact With Data About Facilities and Partners Within
    the Connected Communities Portfolio'
  authors:
  - family-names: Durbin
    given-names: Lee
    email: lee.durbin@aucklandcouncil.govt.nz
  version: 0.0.0.9000
  abstract: This package allows authorised staff at Auckland Council to read from
    and write to Porowhita Hauwhā, a database that stores information about facilities,
    partners, and related data that falls within the Connected Communities portfolio.
  repository-code: https://github.com/lddurbinAC/porowhitahauwha
  url: https://github.com/lddurbinAC/porowhitahauwha
  contact:
  - family-names: Durbin
    given-names: Lee
    email: lee.durbin@aucklandcouncil.govt.nz
  license: MIT
  year: '2022'
repository-code: https://github.com/lddurbinAC/porowhitahauwha
url: https://github.com/lddurbinAC/porowhitahauwha
contact:
- family-names: Durbin
  given-names: Lee
  email: lee.durbin@aucklandcouncil.govt.nz
references:
- type: software
  title: DBI
  abstract: 'DBI: R Database Interface'
  notes: Imports
  authors:
  - name: R Special Interest Group on Databases (R-SIG-DB)
  - family-names: Wickham
    given-names: Hadley
  - family-names: Müller
    given-names: Kirill
    email: krlmlr+r@mailbox.org
    orcid: https://orcid.org/0000-0002-1416-3412
  year: '2022'
  url: https://CRAN.R-project.org/package=DBI
- type: software
  title: dplyr
  abstract: 'dplyr: A Grammar of Data Manipulation'
  notes: Imports
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@rstudio.com
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: François
    given-names: Romain
    orcid: https://orcid.org/0000-0002-2444-4226
  - family-names: Henry
    given-names: Lionel
  - family-names: Müller
    given-names: Kirill
    orcid: https://orcid.org/0000-0002-1416-3412
  year: '2022'
  url: https://CRAN.R-project.org/package=dplyr
- type: software
  title: duckdb
  abstract: 'duckdb: DBI Package for the DuckDB Database Management System'
  notes: Imports
  authors:
  - family-names: Mühleisen
    given-names: Hannes
    email: hannes@cwi.nl
    orcid: https://orcid.org/0000-0001-8552-0029
  - family-names: Raasveldt
    given-names: Mark
    email: mark.raasveldt@cwi.nl
    orcid: https://orcid.org/0000-0001-5005-6844
  year: '2022'
  url: https://CRAN.R-project.org/package=duckdb

GitHub Events

Total

Delete event: 2
Push event: 1
Create event: 1

Last Year

Delete event: 2
Push event: 1
Create event: 1

Dependencies

DESCRIPTION cran

R >= 2.10 depends
DBI * imports
dplyr >= 1.0.9 imports
duckdb >= 0.3.4 imports
here >= 1.0.1 imports
rlang >= 1.0.4 imports
stringr >= 1.4.0 imports
tere >= 0.0.0.9000 imports
testthat >= 3.0.0 suggests

.github/workflows/R-CMD-check.yaml actions

actions/checkout v2 composite
r-lib/actions/check-r-package v2 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/pkgdown.yaml actions

JamesIves/github-pages-deploy-action v4.4.1 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

.github/workflows/test-coverage.yaml actions

actions/checkout v3 composite
actions/upload-artifact v3 composite
r-lib/actions/setup-r v2 composite
r-lib/actions/setup-r-dependencies v2 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science