Skip to content
This repository has been archived by the owner on Oct 28, 2024. It is now read-only.

Commit

Permalink
Merge branch 'main' into dialect-table
Browse files Browse the repository at this point in the history
  • Loading branch information
roll authored May 7, 2024
2 parents a188f89 + a390ca7 commit 6f6d00a
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 19 deletions.
2 changes: 2 additions & 0 deletions content/docs/recipes/enum-labels-and-ordering.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Enum Labels and Ordering
sidebar:
hidden: true
---

<table>
Expand Down
2 changes: 2 additions & 0 deletions content/docs/recipes/metadata-in-table-schema.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Metadata in Table Schema
sidebar:
hidden: true
---

<table>
Expand Down
16 changes: 14 additions & 2 deletions content/docs/specifications/data-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Several example data packages can be found in the [datasets organization on gith

Data Package descriptor `MUST` be a descriptor as per [Descriptor](../glossary/#descriptor) definition. A list of standard properties that can be included into a descriptor is defined in the [Properties](#properties) section.

When available as a file a descriptor `MUST` be named `datapackage.json` and it `MUST` be placed in the top-level directory (relative to any other resources provided as part of the data package).
When a data package is available as a physical or virtual directory containing files, a descriptor `MUST` be named `datapackage.json` and it `MUST` be placed on the top-level of the file structure (relative to any other resources provided as part of the data package).

The descriptor is the central file in a Data Package. It provides:

Expand Down Expand Up @@ -116,7 +116,7 @@ Packaged data resources are described in the `resources` property of the package

### `$schema`

A root level Data Package descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.
A root level Data Package descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.

The default value is `https://datapackage.org/profiles/1.0/datapackage.json` and the recommended value is `https://datapackage.org/profiles/2.0/datapackage.json`.

Expand Down Expand Up @@ -266,3 +266,15 @@ An example of the object structure is as follows:
"path": "http://data.worldbank.org/indicator/NY.GDP.MKTP.CD"
}]
```

## Related Work

Data Package draws content and/or inspiration from, among others, the following specifications and implementations:

- [DataCite](https://schema.datacite.org/)
- [Zenodo](https://zenodo.org/)
- [DCAT](https://www.w3.org/TR/vocab-dcat-3/)
- [CKAN](https://ckan.org/)
- [OAI-ORE](https://www.openarchives.org/ore/)
- [DataONE](https://dataone-architecture-documentation.readthedocs.io/en/latest/design/DataPackage.html)
- [Research Object Bundle](https://www.researchobject.org/specifications/bundle/)
8 changes: 5 additions & 3 deletions content/docs/specifications/data-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ If a resource has `profile` property that equals to `tabular-data-resource` or `

#### `$schema`

A root level Data Resource descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.
A root level Data Resource descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.

The default value is `https://datapackage.org/profiles/1.0/dataresource.json` and the recommended value is `https://datapackage.org/profiles/2.0/dataresource.json`.

Expand Down Expand Up @@ -190,7 +190,7 @@ The MD5 hash for this resource. Other algorithms can be indicated by prefixing t

#### `sources`

List of data sources as for [Data Package](../data-package/#sources).
List of data sources as for [Data Package](../data-package/#sources). If not specified the resource inherits from the data package.

#### `licenses`

Expand All @@ -200,7 +200,9 @@ List of licenses as for [Data Package](../data-package/#licenses). If not specif

The properties below are applicable to any Tabular Data Resource.

#### `data`
#### `path` or `data` [required]

If the `path` property is used for providing data than it `MUST` contain [Tabular Data](../glossary/#tabular-data).

If the `data` property is used for providing data for a Tabular Data Resource than it `MUST` be an `array` where each item in the array `MUST` be either:

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/table-dialect.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ General properties are format-agnostic. Usually, there are useful for defining d

#### `$schema`

A root level Table Dialect descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.
A root level Table Dialect descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.

The default value is `https://datapackage.org/profiles/1.0/tabledialect.json` and the recommended value is `https://datapackage.org/profiles/2.0/tabledialect.json`.

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/table-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The way Table Schema `fields` are mapped onto the data source fields are defined

#### `$schema`

A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST` point to a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.
A root level Table Schema descriptor `MAY` have a `$schema` property that `MUST` be a profile as per [Profile](../glossary/#profile) definition that `MUST` include all the metadata constraints required by this specification.

The default value is `https://datapackage.org/profiles/1.0/tableschema.json` and the recommended value is `https://datapackage.org/profiles/2.0/tableschema.json`.

Expand Down
12 changes: 0 additions & 12 deletions content/docs/standard/recipes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,6 @@ Recipes are various approaches for solving common problems, in ways that are not
href="/recipes/external-foreign-keys"
/>

<LinkCard
title="Metadata in Table Schema"
description="Enrich table schemas with detailed metadata to provide context and meaning to your data."
href="/recipes/metadata-in-table-schema"
/>

<LinkCard
title="Enum Labels and Ordering"
description="Many software packages for manipulating and analyzing tabular data have special features for working with categorical variables."
href="/recipes/enum-labels-and-ordering"
/>

<LinkCard
title="Relationship between Fields"
description="The structure of tabular datasets is simple, however, the data present is often complex and reflects an interdependence between Fields"
Expand Down

0 comments on commit 6f6d00a

Please sign in to comment.