.. SPDX-FileCopyrightText: 2021 Veit Schiele
..
.. SPDX-License-Identifier: BSD-3-Clause

Cite data
=========

DataCite Metadata Schema
------------------------

The DataCite Metadata Working Group published the DataCite Metadata Schema
Documentation for the publication and citation of research data in 2019:
`DataCite Metadata Schema 4.3 <https://schema.datacite.org/meta/kernel-4.3/>`_
together with a XSD (XML Schema Definition): `metadata.xsd
<https://schema.datacite.org/meta/kernel-4.3/metadata.xsd>`_.

A simple datacite example can look like this:

.. code-block:: xml

    <?xml version="1.0" encoding="UTF-8"?>
    <resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://datacite.org/schema/kernel-4" xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4.3/metadata.xsd">
      <identifier identifierType="DOI">10.5072/D3P26Q35R-Test</identifier>
      <creators>
        <creator>
          <creatorName nameType="Personal">Fosmire, Michael</creatorName>
          <givenName>Michael</givenName>
          <familyName>Fosmire</familyName>
        </creator>
        <creator>
          <creatorName nameType="Personal">Wertz, Ruth</creatorName>
          <givenName>Ruth</givenName>
          <familyName>Wertz</familyName>
        </creator>
        <creator>
          <creatorName nameType="Personal">Purzer, Senay</creatorName>
           <givenName>Senay</givenName>
          <familyName>Purzer</familyName>
        </creator>
      </creators>
      <titles>
        <title xml:lang="en">Critical Engineering Literacy Test (CELT)</title>
      </titles>
      <publisher xml:lang="en">Purdue University Research Repository (PURR)</publisher>
      <publicationYear>2013</publicationYear>
      <subjects>
        <subject xml:lang="en">Assessment</subject>
        <subject xml:lang="en">Information Literacy</subject>
        <subject xml:lang="en">Engineering</subject>
        <subject xml:lang="en">Undergraduate Students</subject>
        <subject xml:lang="en">CELT</subject>
        <subject xml:lang="en">Purdue University</subject>
      </subjects>
      <language>en</language>
      <resourceType resourceTypeGeneral="Dataset">Dataset</resourceType>
      <version>1.0</version>
      <descriptions>
        <description xml:lang="en" descriptionType="Abstract">
          We developed an instrument, Critical Engineering Literacy Test (CELT), which is a multiple choice instrument designed to measure undergraduate students’ scientific and information literacy skills. It requires students to first read a technical memo
          and, based on the memo’s arguments, answer eight multiple choice and six open-ended response questions. We collected data from 143 first-year engineering students and conducted an item analysis. The KR-20 reliability of the instrument was .39. Item
          difficulties ranged between .17 to .83. The results indicate low reliability index but acceptable levels of item difficulties and item discrimination indices. Students were most challenged when answering items measuring scientific and mathematical
          literacy (i.e., identifying incorrect information).
        </description>
      </descriptions>
    </resource>

W3C-PROV
--------

The `PROV document family of the W3C working group
<https://www.w3.org/TR/prov-overview/>`_ defines various aspects that are
necessary to be able to exchange provenance information interoperably.

.. seealso::
   * `Provenance: An Introduction to PROV <https://www.provbook.org/>`_ by Luc
     Moreau and Paul Groth
   * `Provenance storage and distribution <https://openprovenance.org/store/>`_
   * `ProvStore’s API documentation
     <https://openprovenance.org/store/help/api/>`_

Python prov
~~~~~~~~~~~

With `prov <https://prov.readthedocs.io/en/latest/>`_, a Python3 library is
available that supports the import and export of the `PROV data model
<https://www.w3.org/TR/prov-dm/>`_ into the following serialisation formats:

* `PROV-O (RDF) <https://www.w3.org/TR/2013/REC-prov-o-20130430/>`_
* `PROV-XML <https://www.w3.org/TR/2013/NOTE-prov-xml-20130430/>`_
* `PROV-JSON <https://www.w3.org/submissions/prov-json/>`_

In addition, PROV documents can be created with :doc:`pyviz:matplotlib/networkx`
`MultiDiGraph
<https://networkx.org/documentation/stable/reference/classes/multidigraph.html>`_
and vice versa. Finally, PROV documents can also be generated as graphs in PDF,
PNG and SVG formats.

.. seealso::
   * `A Short Tutorial for Prov Python
     <https://trungdong.github.io/prov-python-short-tutorial.html>`_ by Dong
     Huynh
   * `PROV Tutorial.ipynb
     <https://nbviewer.org/github/trungdong/notebooks/blob/master/PROV%20Tutorial.ipynb>`_