mirror of
https://github.com/dataforcanada/d4c-service-main-site.git
synced 2026-06-13 14:00:51 +02:00
Make various improvements
This commit is contained in:
Diego Ripley
@@ -31,25 +31,29 @@ We are open to feedback on the current file naming convention.
|
||||
`[iso-region]_[data-source-name]-[DGUID]_[data-pkg]_[iso-date]_[variant]_[version].[extension]`
|
||||
|
||||
**Example**:
|
||||
`ca-ab_city-of-edmonton-2023A00054811061_d4c-datapkg-orthoimagery_2023_075mm_v0.0.1.pmtiles`
|
||||
**[ca_statcan_2021A000011124_d4c-datapkg-statistical_census_pop_census_metropolitan_areas_and_census_agglomerations_2021_v0.1.0-beta.parquet](https://source.coop/dataforcanada/d4c-datapkg-statistical/processed/ca_statcan_2021A000011124_d4c-datapkg-statistical_census_pop_census_metropolitan_areas_and_census_agglomerations_2021_v0.1.0-beta.parquet)**
|
||||
|
||||
#### **Component Breakdown**
|
||||
|
||||
| Segment | Definition | Format / Rules | Example |
|
||||
| :--------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------ |
|
||||
| **1. ISO Region** | The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2:CA), which is a two-letter country code, or [ISO 3166-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en) which identifies the principal subdivisions (ex. provinces, states, etc.) | Lowercase. Hyphenated. | `ca`, `ca-ab` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **2. Data Source and [DGUID](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055)** | **Data Source and [DGUID](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055)**. | Use `[data-source-name]` for the data source and the [`[DGUID]`](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055) for the geographic area it covers. | `city-of-edmonton-2023A00054811061`, `statcan-2021A000011124` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **3. Data Package** | The package name for the dataset (see [High-Level Overview](https://www.dataforcanada.org/#high-level-overview)). | Lowercase. `d4c-datapkg-orthoimagery` | |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **4. ISO Date** | The vintage of the data source. | **ISO 8601**. Flexible precision. | `2023`, `2023-06`, `2023-06-01`, `2026-02-11T19:50:58` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **5. Variant** | Resolution or specific subset info. | **No Projections.** Alphanumeric. Units included. | `075mm`, `30cm` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **6. Version** | **Semantic Versioning**. | `v[Major].[Minor].[Patch]` | `v0.0.1` |
|
||||
| Segment | Definition | Format / Rules | Example |
|
||||
| :-------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------ |
|
||||
| **1. ISO Region** | The [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-2:CA), which is a two-letter country code, or [ISO 3166-2](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en) which identifies the principal subdivisions (ex. provinces, states, etc.) | Lowercase. Hyphenated. | `ca`, `ca-ab` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **2. Data Source Name and [DGUID](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055)** | **Data Source Name and [DGUID](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055)**. | Use `[data-source-name]` for the data source and the [`[DGUID]`](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055) for the geographic area it covers. | `city-of-edmonton-2023A00054811061`, `statcan-2021A000011124` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **3. Data Package** | The package name for the dataset (see [High-Level Overview](https://www.dataforcanada.org/#high-level-overview)). | Lowercase. `d4c-datapkg-orthoimagery` | |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **4. ISO Date** | The vintage of the data source. | [**ISO 8601**](). Flexible precision. | `2023`, `2023-06`, `2023-06-01`, `2026-02-11T19:50:58` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **5. Variant** | Resolution or specific subset info. | **No Projections.** Alphanumeric. Units included. | `075mm`, `30cm` |
|
||||
| **_** | *Separator* | Underscore | |
|
||||
| **6. Version** | **Semantic Versioning**. | `v[Major].[Minor].[Patch]` | `v0.0.1` |
|
||||
|
||||
## 2. Component Detail
|
||||
{{% details title="Details" closed="true" %}}
|
||||
|
||||
|
||||
|
||||
|
||||
### A. Source / Location ID (Flexible)
|
||||
|
||||
@@ -72,11 +76,6 @@ Dates follow strictly **ISO 8601**, but the precision can vary based on the natu
|
||||
|
||||
* **Learn More:** [Wikipedia: ISO 8601 Date and Time Format](https://en.wikipedia.org/wiki/ISO_8601)
|
||||
|
||||
**Examples of Date Precision:**
|
||||
|
||||
* **Month Precision:** `ca_statcan-2024A000011124_d4c-datapkg-statistical_2024-12_v0.0.1.parquet`
|
||||
* **Day Precision:** `ca_statcan-2025A000011124_d4c-datapkg-statistical_2025-04-15_v0.0.1.parquet`
|
||||
|
||||
### D. Variant
|
||||
|
||||
This field is strictly for **resolution** (e.g., `075mm`, `1m`) or content subsets.
|
||||
@@ -90,11 +89,13 @@ We use **SemVer** (`vMAJOR.MINOR.PATCH`) to track changes to datasets.
|
||||
|
||||
* **Link:** [SemVer.org](https://semver.org/)
|
||||
|
||||
| Component | Logic for Data | Example Scenario |
|
||||
| :--- | :--- | :--- |
|
||||
| **MAJOR** | **Breaking Change.** The schema changed, columns were renamed/removed, or the meaning of the data changed significantly. Old code will break. | `v0.0.1` → `v1.0.0`<br>*(Renamed column `geo_id` to `dguid`)* |
|
||||
| **MINOR** | **New Feature (Non-Breaking).** New columns were added, or coverage was expanded, but old columns remain. Old code still runs. | `v0.0.1` → `v0.1.0`<br>*(Added a `population_density` column)* |
|
||||
| **PATCH** | **Bug Fix.** Incorrect data values were fixed, but the schema (columns) is identical. | `v0.0.1` → `v0.0.2`<br>*(Fixed typo in metadata or coordinate precision)* |
|
||||
| Component | Logic for Data | Example Scenario |
|
||||
| :-------- | :-------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------ |
|
||||
| **MAJOR** | **Breaking Change.** The schema changed, columns were renamed/removed, or the meaning of the data changed significantly. Old code will break. | `v0.0.1` → `v1.0.0`<br>*(Renamed column `geo_id` to `dguid`)* |
|
||||
| **MINOR** | **New Feature (Non-Breaking).** New columns were added, or coverage was expanded, but old columns remain. Old code still runs. | `v0.0.1` → `v0.1.0`<br>*(Added a `population_density` column)* |
|
||||
| **PATCH** | **Bug Fix.** Incorrect data values were fixed, but the schema (columns) is identical. | `v0.0.1` → `v0.0.2`<br>*(Fixed typo in metadata or coordinate precision)* |
|
||||
|
||||
{{% /details %}}
|
||||
|
||||
## 3. Helper Tools
|
||||
|
||||
|
||||
Reference in New Issue
Block a user