dataforcanada/d4c-service-main-site
1
0
Fork 0
mirror of https://github.com/dataforcanada/d4c-service-main-site.git synced 2026-06-13 14:00:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Alright, draft v0.1.0-beta 😂

Browse Source
This commit is contained in:
Diego Ripley
2026-02-22 08:10:17 -05:00
parent dc5e72f6d5
commit cb19861f99
1 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/docs/getting_started/file_naming_convention.md
+9 -10
View File
@@ -1,12 +1,14 @@
--- ---
title: File Naming Convention title: "Data for Canada: File Naming Convention (DFC-FNC)"
weight: 1 weight: 1
next: /docs/d4c-pkgs next: /docs/d4c-pkgs
sidebar: sidebar:
open: true open: true
--- ---
## Data for Canada: File Naming Convention (DFC-FNC) {{< callout type="important">}}
We are open to feedback on the current file naming convention.
{{< /callout >}}
## Background ## Background
@@ -25,19 +27,16 @@ See Statistics Canada's [geographic hiearchy](https://www12.statcan.gc.ca/census
All published datasets must adhere to the following structure to ensure files are machine-parsable, sortable by region, and identifiable by human readers. **This file naming convention will be modified as we solidify our processes**. All published datasets must adhere to the following structure to ensure files are machine-parsable, sortable by region, and identifiable by human readers. **This file naming convention will be modified as we solidify our processes**.
{{< callout type="important">}}
We are open to feedback on the current file naming convention.
{{< /callout >}}
{{% details title="File Naming Convention" closed="true" %}} {{% details title="File Naming Convention" closed="true" %}}
#### **Syntax**
### **Syntax**
`[iso-region]_[data-source-name]-[DGUID]_[data-pkg]_[iso-date]_[variant]_[version].[extension]` `[iso-region]_[data-source-name]-[DGUID]_[data-pkg]_[iso-date]_[variant]_[version].[extension]`
**Example**: **Example**:
**[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)** **[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** ### **Component Breakdown**
| Segment | Definition | Format / Rules | Example | | Segment | Definition | Format / Rules | Example |
| :-------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------ | | :-------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------ |
@@ -102,8 +101,7 @@ We use **SemVer** (`vMAJOR.MINOR.PATCH`) to track changes to datasets.
## 3. Helper Tools ## 3. Helper Tools
### **Statistics Canada Geography Search** {{% details title="Statistics Canada Geography Search" closed="true" %}}
{{< callout type="warning" >}} {{< callout type="warning" >}}
In the tool below, you can click on each individual **[DGUID](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055)** to see their associated geography. In the tool below, you can click on each individual **[DGUID](https://www12.statcan.gc.ca/census-recensement/2021/ref/dict/az/definition-eng.cfm?ID=geo055)** to see their associated geography.
{{< /callout >}} {{< /callout >}}
@@ -113,3 +111,4 @@ To accurately populate the **[DGUID](https://www12.statcan.gc.ca/census-recensem
* **Tool URL:** [https://statcan-geography.labs.dataforcanada.org/](https://statcan-geography.labs.dataforcanada.org/) * **Tool URL:** [https://statcan-geography.labs.dataforcanada.org/](https://statcan-geography.labs.dataforcanada.org/)
* **Source Code:** [GitHub Repository](https://github.com/dataforcanada/statcan-geography.labs.dataforcanada.org) * **Source Code:** [GitHub Repository](https://github.com/dataforcanada/statcan-geography.labs.dataforcanada.org)
* **Usage:** Enter a city or region name to retrieve the correct colloquial name and DGUID pairing (e.g., searching "Ottawa" returns `2021A00053506008`). * **Usage:** Enter a city or region name to retrieve the correct colloquial name and DGUID pairing (e.g., searching "Ottawa" returns `2021A00053506008`).
{{% /details %}}