digitalnz / README.md
edithatogo's picture
Define canonical Dataset Viewer configurations
9edc83c verified
|
Raw
History Blame Contribute Delete
3.27 kB
---
pretty_name: "DigitalNZ and RNZ Source Archive"
language:
- en
license: other
task_categories:
- text-retrieval
tags:
- new-zealand
- digitalnz
- rnz
- source-archive
- mixed-rights
configs:
- config_name: digitalnz_collections
data_files:
- split: train
path: digitalnz/digitalnz_collections.csv
- config_name: digitalnz_country_totals
data_files:
- split: train
path: digitalnz/country_totals.csv
- config_name: digitalnz_papers_past_newspapers
data_files:
- split: train
path: digitalnz/paperspast_newspapers.csv
- config_name: rnz_collections
data_files:
- split: train
path: rnz/collections.csv
- config_name: rnz_usage
data_files:
- split: train
path: rnz/usage_by_collection_and_partner.csv
- config_name: rnz_release_manifests
data_files:
- split: train
path: rnz/releases/*/manifest-*.parquet
---
# DigitalNZ and RNZ Source Archive
## Registry status
- Registry ID: `edithatogo/digitalnz`
- Family: `nz-cultural-heritage`
- Repository role: `mixed_source_archive`
- Canonical dataset: [`edithatogo/digitalnz`](https://huggingface.co/datasets/edithatogo/digitalnz)
- Operational status: `active_mixed_bundle`
- Rights status: `component_specific_review_required`
- Authoritative catalog: [`edithatogo/dataset-estate-registry`](https://huggingface.co/datasets/edithatogo/dataset-estate-registry)
## Origin and provenance
- Origin repository: [https://github.com/edithatogo/dnz](https://github.com/edithatogo/dnz)
- Upstream source: DigitalNZ API material, legacy pydnz code, and reviewed RNZ-derived assets.
- This card describes repository identity and relationships; it does not claim completeness beyond published manifests.
## Rights boundary
Repository code, dataset compilation, and underlying source-record rights are separate.
The registry currently records the rights state as `component_specific_review_required`.
Where rights vary by record or source, downstream users must inspect the published provenance and rights fields.
## Existing dataset documentation
This archive packages the checked-in DigitalNZ source trees and the RNZ archive bundle for long-term citation and reuse.
## Source Trees
- `digitalnz/`: notebook-led DigitalNZ API exploration, harvested facet data, and source artifacts used to derive collection inventories.
- `pydnz/`: the legacy Python client source tree for the DigitalNZ API.
- `rnz/`: RNZ recordings and associated documents derived from checked-in facet exports.
## Contents
- Notebook-led DigitalNZ source material and generated facet inventories.
- Legacy Python client source files and package metadata.
- RNZ collection metadata, rights snapshots, and recording inventories.
- Source README and license files from each included tree.
## Notes
- The archive intentionally excludes Git metadata from copied source trees.
- The workflow publishes source snapshots, not the active working tree or repo history.
- The archive scope can expand later if more source-led trees or archive bundles are added to the repo.
## Reconciliation policy
This repository is retained only while its recorded role is distinct from the canonical dataset.
Renames, deletion, visibility changes, and replacement of immutable DOI snapshots require explicit human review.