Merge pull request #84 from bact/add-owid-co2-data

Add a Dataset Profile example (CO2 dataset)

Author: kestewart

dataset/README.md

@@ -0,0 +1,19 @@
+# SPDX Dataset Profile Examples
+
+This repository includes demonstrations of [SPDX documents](https://spdx.dev)
+for a Dataset Profile.
+
+## Format of examples
+
+Directories of the form `example##` are structured as follows:
+
+- `content/`: contains the example's content (data files, related source code,
+  etc.)
+- `spdx3.0/`: contains one or more SPDX documents for the example
+- `README.md`: more details about the particular example
+
+## Examples
+
+| ## | Data | Sources | SPDX | Comments |
+|----|------|---------|------|----------|
+| [01](./example01/) | 2 CSV files | - | 1 document | An example of a simple dataset in tabular format. |

dataset/example01/README.md

@@ -0,0 +1,33 @@
+# Example 01
+
+## Description
+
+An example of a simple dataset in tabular format.
+
+```text
+content
+├── codebook.csv
+└── data.csv
+```
+
+Both `codebook.csv` and `data.csv` are plain text files in CSV (comma-separated
+values) format.
+
+The file `data.csv` contains records of gas emission data for each year in a
+country. It has a header on the first line that defines the column names.
+Each record consists mostly of numerical data with some categorical data.
+
+The file `codebook.csv` contains the column names from the header of
+`data.csv`, together with their description, unit, and source.
+
+The content of this example is an excerpt of the Our World in Data CO2 and
+Greenhouse Gas Emissions dataset. It is available in full, under Creative
+Commons Attribution 4.0 International License, at
+<https://github.com/owid/co2-data/>.
+
+This simplified
+[Unified Modeling Language (UML)](https://en.wikipedia.org/wiki/Unified_Modeling_Language)
+class diagram illustrates Example 01.  Long string values are truncated and the
+spdxIds are shortened (by removing the UUID suffix), for brevity.
+
+[![A diagram of a bill of materials of Dataset Example 01](./spdx3.0/example01.png "A diagram of a bill of materials of Dataset Example 01")](./spdx3.0/example01.png)