Skip to content

Commit b5103ee

Browse files
committed
📝 Add citation specifications for data
1 parent b27bcd4 commit b5103ee

3 files changed

Lines changed: 72 additions & 0 deletions

File tree

‎CHANGELOG.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ emergencies when we need to start branches for older versions.
2323
Added
2424
~~~~~
2525

26+
* 📝 Add citation specifications for data
2627
📝 Add CSVW
2728

2829
* Switch to xan

‎docs/data-processing/glossary.rst‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,26 @@ Glossary
183183
The data infrastructure is provided by a data platform team in the
184184
form of a data platform based on the self-service principle.
185185

186+
Data Package
187+
Frictionless Specs
188+
`Data Package <https://datapackage.org/standard/data-package/>`_ is a
189+
lightweight, open-source standard for bundling, describing, and ensuring
190+
FAIR use of datasets.
191+
192+
Data Package Descriptor
193+
Central JSON file :file:`datapackage.json` in the root directory
194+
containing general metadata (such as title, license, authors) and a
195+
list of resources.
196+
Data Resource
197+
describes individual files or data sources (path, format, URL).
198+
Table Schema
199+
JSON schema for tabular data (column types, data types such as
200+
``string``/``integer``/``date``, constraints, and external foreign
201+
keys).
202+
Table Dialect
203+
describes CSV dialect formatting (delimiters, quotation marks,
204+
header rows).
205+
186206
Data Warehouse
187207
A database optimised for analytical purposes with the following
188208
characteristics:
@@ -198,13 +218,37 @@ Glossary
198218
nonvolatile
199219
Data is stored permanently, not just temporarily
200220

221+
`DataONE Data Packaging
222+
<https://dataone-architecture-documentation.readthedocs.io/en/latest/design/DataPackage.html>`_
223+
is a bundled collection that contains at least one scientific metadata
224+
document, one or more data objects, and an RDF resource mapping that
225+
defines their relationships using :term:`OAI-ORE` terms.
226+
201227
DataOps
202228
Modelled on :term:`DevOps`, DataOps aims to make previously isolated
203229
data processing functions automated, agile and consistent. Through
204230
continuous testing and monitoring, DataOps helps to improve data quality
205231
and availability in :term:`data warehouses <Data warehouse>`,
206232
:term:`data lakes <Data lake>` and :term:`data meshes <Data mesh>`.
207233

234+
DCAT
235+
Data Catalog Vocabulary
236+
`DCAT <https://www.w3.org/TR/vocab-dcat-3/>`_ is a metadata standard
237+
developed by the W3C for describing datasets and data catalogues on the
238+
web. It is designed to facilitate the discovery, linking and exchange of
239+
data, and uses :abbr:`RDF (Resource Description Framework)` for this
240+
purpose. It primarily distinguishes between a *catalogue*, a *dataset*
241+
and the *distribution* of a dataset.
242+
243+
DCAT-AP.de
244+
A Common German Metadata Model for the Exchange of Open Government Data.
245+
246+
.. seealso::
247+
* `DCAT-AP.de Spezifikation 3.0
248+
<https://www.dcat-ap.de/def/dcatde/3.0/spec/>`_
249+
* `Metadatenschema
250+
<https://www.govdata.de/informationen/metadatenschema>`_
251+
208252
DevOps
209253
A software development methodology that accelerates the delivery of
210254
software applications and services by integrating and automating
@@ -297,6 +341,12 @@ Glossary
297341
which are often used in functional programming, even if the semantics
298342
deviate slightly from them.
299343

344+
MediaWiki Tabular Data
345+
MediaWiki `Tabular Data
346+
<https://www.mediawiki.org/wiki/Help:Tabular_data>`_ stores structured
347+
rows and columns as JSON in the ``Data:`` namespace, with the file
348+
extension :file:`.tab` tab for cross-wiki lists and charts.
349+
300350
MLOps
301351
MLOps combines machine learning (ML) and :term:`DevOps` and is a process
302352
for building and operating machine learning models, whereby the
@@ -368,6 +418,13 @@ Glossary
368418
UNLOCK
369419
removes the locks SLOCK and XLOCK.
370420

421+
OAI-ORE
422+
ORE
423+
Open Archives Initiative Object Reuse and Exchange
424+
`Open Archives Initiative Object Reuse and Exchange (OAI-ORE)
425+
<https://www.openarchives.org/ore/>`_ defines standards for the
426+
description and exchange of aggregations of web resources.
427+
371428
Vector clock
372429
A vector clock is a software component used to assign unique time stamps
373430
to messages. It allows a causal order to be assigned to the events in

‎docs/productive/cite/data.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@
55
Cite data
66
=========
77

8+
Similar to the way in which researchers routinely provide bibliographical
9+
references to other academic sources, data should also be cited. Although data
10+
is frequently shared, it is not always cited in the same way, thereby hindering
11+
access, transparency, reproducibility and reuse.
12+
13+
.. seealso::
14+
* :term:`Data Package`
15+
* :term:`DCAT`
16+
* :term:`DCAT-AP.de`
17+
* :term:`OAI-ORE`
18+
* :term:`DataONE Data Packaging`
19+
* `Springer Nature: Data repository guidance
20+
<https://www.springernature.com/gp/authors/research-data-policy/recommended-repositories>`_
21+
822
DataCite Metadata Schema
923
------------------------
1024

0 commit comments

Comments
 (0)