Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ website:
contents:
- docs/guide/installation.qmd
- docs/guide/cli.qmd
- docs/guide/custom-styles.qmd

quartodoc:
sidebar: "docs/reference/_sidebar.yml"
Expand Down
75 changes: 1 addition & 74 deletions docs/design/interface/outputs.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -54,80 +54,7 @@ stage records for those species.
### Expand to see the `datapackage.json` content

``` {.json filename="datapackage.json"}
{
"name": "flora",
"title": "Observations of flora species and seasonal development",
"id": "29b1b5e4-3f4c-4d2a-9f8e-123456789abc",
"description": "A dataset containing flora species records and their observed growth stages across different environments.",
"version": "1.2.3",
"licenses": [
{
"name": "CCO 1.0 UNIVERSAL",
"path": "https://creativecommons.org/publicdomain/zero/1.0/legalcode"
}
],
"contributors": [
{
"title": "Jane Doe",
"role": ["creator"],
"email": "jane-doe@example.com",
"organization": "Example University"
},
{
"title": "John Smith",
"role": ["author"],
"email": "john-smith@example.com",
"organization": "Example Institute"
}
],
"sources": [{ "title": "Example Data Source", "version": "1.0", "path": "https://example.com/data-source", "email": "source@example.com" }],
"resources": [
{
"name": "species_catalog",
"title": "Flora Species",
"description": "This resource contains a catalog of flora species.",
"path": "resources/species_catalog/data.parquet",
"format": "parquet",
"encoding": "utf-8",
"primaryKey": "species_id",
"schema": {
"fields": [
{ "title": "Species ID", "name": "species_id", "type": "integer", "description": "The unique identifier for each species." },
{ "title": "Scientific name", "name": "scientific_name", "type": "string", "description": "The Latin name of the species." },
{ "title": "Common name", "name": "common_name", "type": "string", "description": "The common name of the species." },
{ "title": "Family", "name": "family", "type": "string", "description": "The Latin family to which the species belongs." }
]
},
"sources": [
{ "title": "Flora Species Source", "version": "1.0", "path": "https://example.com/data-source/flora-species", "email": "source@example.com" }]
},
{
"name": "growth_records",
"title": "Growth Stage Records",
"description": "This resource contains records of observed growth stages for various flora species.",
"path": "resources/growth_records/data.parquet",
"format": "parquet",
"encoding": "utf-8",
"primaryKey": "record_id",
"foreignKey": {
"fields": "species_id",
"reference": {
"resource": "species_catalog",
"fields": "species_id"
}
},
"schema": {
"fields": [
{ "title": "Record ID", "name": "record_id", "type": "integer", "description": "The unique identifier for each growth record." },
{ "title": "Species ID", "name": "species_id", "type": "integer", "description": "The unique identifier for each species." },
{ "title": "Observation date", "name": "observation_date", "type": "date", "description": "The date when the observation was made." },
{ "title": "Growth Stage", "name": "growth_stage", "type": "string", "description": "The observed growth stage of the species." },
{ "title": "Location", "name": "location", "type": "string", "description": "The location where the observation was made." }
]
}
}
]
}
{{< include /docs/includes/datapackage.json >}}
```
:::

Expand Down
Loading