repository template
Provide a short summary of the repository's purpose
Example:"This repository contains a collection of Python scripts for the production of Subnational Population Estimates. It also includes metadata for contributors to understand how Subnational Population Estimates are being produced."
List any software, programming languages, or packages required for the repository to operate.
Example:
- R ≥ 4.3.0 (packages: ggplot2, dplyr)
- Python ≥ 3.9 (modules: pandas, numpy)
- SQL (tested on PostgreSQL 13)
- SAS ≥ 9.4
Provide instructions for installing dependencies or using package managers (pip, renv, npm, etc)
Example(Python): pip install -r requirements.txt Example(R): install.packages('renv'), renv::restore()
Provide examples of how to run scripts or use the materials.
Example: bash: python src/analysis.py --input data/input.csv --output results/output.csv
We welcome contributions. Please read our CONTRIBUTING.md guidelines before submitting pull requests. Fork the repository and create a feature branch (feature/short-description)Submit a pull request to the uat branchEnsure code development pass unit test and follow coding standards.
The package is Crown copyright (c), [YEAR] Tatauranga Aotearoa Statistics New Zealand on behalf of the New Zealand Government, and is licensed under the MIT License (see LICENSE file).
This document is Crown copyright (c), Tatauranga Aotearoa Statistics New Zealand on behalf of the New Zealand Government, and is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
DO NOT hard code secrets, API keys, credentials or personal/sensitive data in your code. If accidental leak occurs, inform administrator immediately. Repositories might be scanned with automated secrets detection tools such as gitleaks and trufflehog
If the contents and/or data produced using this repository contributes to research or statistical publications, please cite as:
Statistics NZ, Tatauranga Aotearoa. (Year). Repository Title. GitHub. URL