diff --git a/.editorconfig b/.editorconfig index be794c1..14281d9 100644 --- a/.editorconfig +++ b/.editorconfig @@ -8,9 +8,6 @@ trim_trailing_whitespace = true insert_final_newline = true max_line_length = off -[*.rst] -indent_size = 4 - [*.bat] indent_style = tab end_of_line = crlf diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4254d7a..d6c3e76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,10 +43,11 @@ First, install the required dependencies (preferably in a virtual environment): ```bash python -m venv venv source venv/bin/activate - pip install -r requirements.txt ``` +**Note**: To activate the env on Windows, run in cmd: `venv\Scripts\activate.bat`. + Then, you can build the documentation using the following command: ```bash diff --git a/CONTRIBUTORS.yml b/CONTRIBUTORS.yml index 490681f..5b7c46d 100644 --- a/CONTRIBUTORS.yml +++ b/CONTRIBUTORS.yml @@ -5,6 +5,20 @@ Marek Suchánek: orcid: 0000-0001-7525-9218 affiliation: CTU in Prague +Jana Martínková: + first_name: Jana + last_name: Martínková + github: jmartinkova + orcid: 0000-0001-8575-6533 + affiliation: CTU in Prague + +Vojtěch Knaisl: + first_name: Vojtěch + last_name: Knaisl + github: vknaisl + orcid: 0000-0003-0103-8468 + affiliation: Codevence Solutions + Daniel Garijo: first_name: Daniel last_name: Garijo @@ -39,3 +53,69 @@ Allyson Lister: github: allysonlister orcid: 0000-0002-7702-4495 affiliation: University of Oxford + +Raul Palma: + first_name: Raul + last_name: Palma + github: rapw3k + orcid: 0000-0003-4289-4922 + affiliation: Poznan Supercomputing and Networking Center + +Katja Moilanen: + first_name: Katja + last_name: Moilanen + github: katja-moilanen + orcid: 0000-0002-7668-5427 + affiliation: TAU-FSD/CESSDA + +Andrea Mannocci: + first_name: Andrea + last_name: Mannocci + github: andremann + orcid: 0000-0002-5193-7851 + affiliation: CNR-ISTI + +Paolo Manghi: + first_name: Paolo + last_name: Manghi + github: paolomanghi + orcid: 0000-0001-7291-3210 + affiliation: CNR-ISTI + +Miriam Baglioni: + first_name: Miriam + last_name: baglioni + github: mirima2 + orcid: 0000-0002-2273-9004 + affiliation: CNR-ISTI + +Pablo Alarcón-Moreno: + first_name: Pablo + last_name: Alarcón-Moreno + github: pabloalarconm + orcid: 0000-0001-5974-589X + affiliation: Universidad Politécnica de Madrid + +Renaud Duyme: + first_name: Renaud + last_name: Duyme + github: rduyme + affiliation: ESFR + +Andres Tabima: + first_name: Andres + last_name: Tabima + github: andresTabiTuwien + orcid: 0009-0002-4848-5089 + affiliation: TU Wien + +Menzo Windhower: + first_name: Menzo + last_name: Windhowe + orcid: 0000-0002-2204-4018 + affiliation: KNAW + +Daan Broader: + first_name: Daan + last_name: Broader + affiliation: KNAW diff --git a/README.md b/README.md index b88fc8e..5d4ba3b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ ## Usage -This repository contains the source files for the OSTrails documentation. The documentation is hosted on Read-the-Docs and can be accessed [here](https://docs.ostrails.eu/en/latest/). +This repository contains the source files for the OSTrails documentation. The documentation is hosted on Read-the-Docs and can be accessed (only for this branch) [here](https://ostrails-docs--22.org.readthedocs.build/en/22/commons/resources.html). ## Contributing diff --git a/docs/architecture/skg_if.rst b/docs/architecture/skg_if.rst index a230c1f..02e88e6 100644 --- a/docs/architecture/skg_if.rst +++ b/docs/architecture/skg_if.rst @@ -2,7 +2,8 @@ Architecture: SKG IF ==================== .. page-authors:: - Tomasz Miksa + Andrea Mannocci + Paolo Manghi This page introduces the Scientific/Scholarly Knowledge Graph Interoperability Framework (SKG-IF). It outlines its motivation, relation to key elements, and applications in OSTrails. diff --git a/docs/commons/FAIR/Assessment-Recommended-API.rst b/docs/commons/FAIR/Assessment-Recommended-API.rst new file mode 100644 index 0000000..de04713 --- /dev/null +++ b/docs/commons/FAIR/Assessment-Recommended-API.rst @@ -0,0 +1,99 @@ +Assessment Recommended API +========================== + +The FAIR-IF follows, as closely as possible, the REST standard; +however, unlike many REST architectures, not all identifiers in +the IF are “local”, and thus it is often necessary to pass the +full GUID of an identifier from one component to another, or from +client to server. For example, the GUID of a Benchmark is the +DOI of that Benchmark as recorded in the FAIRsharing registry, +and as such, it cannot become part of the URL of the REST interface. + +Nevertheless, there are two “types” of calls in the FAIR-IF. +Calls that are intended to retrieve information and calls that are +intended to trigger an activity (such as a test or assessment). +The latter kinds of calls are prefixed with /assess/. + +Please refer to the paragraphs below for API calls or implementation. +An OpenAPI yaml specification for FTR is available in the following [link](https://github.com/OSTrails/FAIR_testing_resource_vocabulary/blob/main/development/api/open_api_description.yaml) including examples and +method calls. + + +GET calls +--------- + +Each of following methods will return metadata of the artifact in JSON-LD, +following the FAIR-IF Application Profile. The method MUST accept a GET +string with key/value as in the table below. The same method MAY accept a JSON +Body as in Table 1, via HTTP POST. + +.. list-table:: GET endpoints + :header-rows: 1 + :widths: 20 20 60 + + * - Method + - Parameter + - Returns + * - ``/tests/`` + - ``testid`` + - A list with all the test identifiers supported by the tool. + When an id is sent, a DCAT record in JSON-LD is returned. + * - ``/benchmarks/`` + - ``bmid`` + - A list with all the benchmark identifiers supported by the tool. + When an id is sent, a DCAT record in JSON-LD is returned. + * - ``/metrics/`` + - ``mid`` + - A list with all the metrics identifiers supported by the tool. + When an id is sent, a DCAT record in JSON-LD is returned. + * - ``/algorithms/`` + - ``aid`` + - A list with all the algorithms identifiers supported by the tool. + When an id is sent, a DCAT record in JSON-LD is returned. + +POST calls +---------- + +All post requests must submit a body with the resource to assess as follows: + +.. code-block:: json + + { + "resource_identifier": "https://w3id.org/example#" + } + +.. list-table:: POST endpoints + :header-rows: 1 + :widths: 20 20 60 + + * - Method + - Parameter + - Returns + * - ``/assess/test/`` + - ``testid`` and ``resource_identifier`` + - Test result in JSON-LD + * - ``/assess/benchmark/`` + - ``bmid`` and ``resource_identifier`` + - Test result in JSON-LD + * - ``/assess/algorithm/`` + - ``algoid`` and ``resource_identifier`` + - Test result in JSON-LD + +In some cases, FAIR assessments may require inspecting multiple large resources. This is, for example, the case when assessing Research Objects. In such situations, the API may not immediately return the test results in JSON-LD format. Instead, it returns a JSON response with the following information: + +.. code-block:: json + + { + "ticket_id": "" + } + +In this case, the API returns an HTTP status code **202 (Accepted)**, indicating that the assessment request has been successfully created. Additionally, the response header **Location** contains a link where the results will be available once generated. + +The link follows this format:: + + /assess/algorithm/{ticket_id} + +When accessing this link, you may receive one of the following HTTP status codes: + +- **404 (Not Found)** if the results have not yet been generated +- **200 (OK)** if the results are available, returned in the same JSON-LD format as a standard test result diff --git a/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst b/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst new file mode 100644 index 0000000..91b83f5 --- /dev/null +++ b/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst @@ -0,0 +1,53 @@ +FAIR Testing Resource Vocabulary (FTR) +======================================= + +Definition +---------- + +The FAIR Testing Resource Vocabulary (FTR) is an ontology created to +describe the results of FAIR Assessment in a consistent, +machine-readable way. Its purpose is to help different FAIR assessment +tools communicate the same language for transparency and reusability. + +FTR is the **application profile** of the assessment components, +acting as a reference model that extends W3C standards such as +`DCAT `_, +`DQV `_, +`PROV `_, +and others to describe the different assessment components, such as: + +- **Test**: Service, formed by an API and associated piece of code that implements a Metric, and is executed (by a FAIR assessment tool), retrieving a particular and standardised result. +- **TestResult**: Output of running a test over a resource. A test result should also contain provenance metadata about the process followed to create it. ``TestResult`` is represented as an extension of ``prov:Entity``. A test result points to the corresponding test through the ``ftr:outputFromTest`` property. +- **TestResultSet**: A set of FAIR test results, together with their respective metadata. Common metadata may describe the set. For example, if all results were run by a request to the same API. +- **TestExecutionActivity**: The action carried out by an agent + +calling an API in which a test (or set of tests) was run. The result +of this activity is either a ``TestResult`` or a ``TestResultSet``. + +- **Metric**: Narrative domain-agnostic description that a Test must wholly implement. +- **Benchmark**: Community-specific groupings of a set of Metrics that provide a narrative describing how that community defines FAIR for assessment purposes. +- **ScoringAlgorithm**: Piece of code that contextualises the sum of all test results for a given benchmark into a final quantitative assessment result. +- **ScoringAlgorithmActivity**: The action carried out by an agent calling an API in which a ``ScoringAlgorithm`` was executed. The result of this activity is a ``BenchmarkScore``. +- **BenchmarkScore**: Output of a Scoring Algorithm over a resource, generating the final score and guidance for the whole assessment. + +---- + +.. image:: https://github.com/OSTrails/FAIR_testing_resource_vocabulary/blob/main/development/img/FAIRTestResult_diagram_v12.drawio.png?raw=true + :align: center + + +Specification +------------- + + * The full FAIR Testing Resource Vocabulary (FTR) 1.2.0 is specified here: https://w3id.org/ftr/1.2.0 + + * You can also explore the GitHub repository for additional content: https://github.com/OSTrails/FAIR_assessment_output_specification/ + + +FAIR assessment validation +-------------------------- + +FTR also includes `ShEX and SHACL files `_ +for the different assessment components, allowing you to validate your +FTR records against this representation using any RDF validator tool, +such as `rudof `_. diff --git a/docs/commons/FAIR/FAIR-commons.rst b/docs/commons/FAIR/FAIR-commons.rst new file mode 100644 index 0000000..d50bd44 --- /dev/null +++ b/docs/commons/FAIR/FAIR-commons.rst @@ -0,0 +1,15 @@ +FAIR Commons +============= + +The following resources in this section are part of the FAIR Commons component. + + +.. toctree:: + :caption: Commons + :maxdepth: 1 + :titlesonly: + + Guidance Element Specification + FAIR Test Results Vocabulary (FTR) + Assessment Recommended API + Code of Shared Tests diff --git a/docs/commons/FAIR/Guidance-Element-Specification.rst b/docs/commons/FAIR/Guidance-Element-Specification.rst new file mode 100644 index 0000000..68d6c99 --- /dev/null +++ b/docs/commons/FAIR/Guidance-Element-Specification.rst @@ -0,0 +1,14 @@ +FAIR Guidance Vocabulary Specification (FGV) +============================================= + +The **FAIR Guidance Vocabulary (FGV)** provides a machine-readable ontology that implements the FAIR Guidance Model described in the OSTrails Deliverable D1.3. It formalizes the structure of FAIR-enabling guidance by extending and aligning with standards such as `DCAT `__, `Schema.org `__, and the `Semanticscience Integrated Ontology (SIO) `__. + +**FGV** describes Guidance Entities—including their *typology* (e.g., FAQ, Best Practice), their links to *external resources* (such as webpages, annotations, or API responses), and their conceptual *focus areas* (e.g., How, Why, What). This enables consistent, interoperable, and machine-actionable representation of guidance across systems and services in a FAIR manner. + +The code release provides the ontology, including vocabularies, definitions, and specifications in machine-readable form. + + - **Persistent identifier**: `https://w3id.org/fgv# `__ + - **Code Repository**: https://github.com/OSTrails/FAIR-Guidance-Vocabulary/ + - **Latest Release**: https://github.com/OSTrails/FAIR-Guidance-Vocabulary/releases/latest + - **Documentation**: https://ostrails.github.io/FAIR-Guidance-Vocabulary/ + - **License**: Creative Commons Attribution 4.0 International `CC-BY 4.0 `__ diff --git a/docs/commons/FAIR/Shared-Tests.rst b/docs/commons/FAIR/Shared-Tests.rst new file mode 100644 index 0000000..043b274 --- /dev/null +++ b/docs/commons/FAIR/Shared-Tests.rst @@ -0,0 +1,15 @@ +Shared Tests +============== + +The FAIR-IF defines the API for assessments. + +In OSTrails, code for assessment tools ("Tests") that adhere to that API is stored in public GitHub repositories. +The repository reflects, primarily, the origin assessment platform that authored the test (e.g. Champion vs. FOOPS!) + +This code can be deployed by anyone, or can be used as a template to guide independent implementations of Tests. + +Repositories +------------- + + - **FAIR Champion Core FAIR Tests**: https://github.com/wilkinsonlab/FAIR-Core-Tests + - **FAIR Champion OSTrails Pilots Community Tests**: https://github.com/wilkinsonlab/Community-FAIR-Tests diff --git a/docs/commons/dmp/application-profile.rst b/docs/commons/dmp/application-profile.rst new file mode 100644 index 0000000..10c03f1 --- /dev/null +++ b/docs/commons/dmp/application-profile.rst @@ -0,0 +1,72 @@ +OSTrails Application Profile for maDMPs +======================================= + +.. page-authors:: + Tomasz Miksa + Marek Suchánek + Jana Martínková + + +The **OSTrails Application Profile (AP) for machine-actionable Data Management Plans (maDMPs)** is a tailored extension of the :doc:`RDA DMP Common Standard (DCS) for maDMPs `. + +It is designed to enhance interoperability while addressing requirements from national and thematic pilots, often reflecting specific funder and community templates. The profile provides a list of additional terms that can be used to express information contained in DMPs in a machine-actionable way. + +Upon successful review, some of the fields from the AP will be incorporated into the RDA DCS. This process is still ongoing and requires broader community consensus and RDA involvement. + +The work presented on this page reflects the **working draft as of January 2026**. + +Purpose and scope +----------------- + +The OSTrails AP enhances interoperability by introducing **additional entities, fields, constraints, and usage patterns** that are not covered by the minimal core defined in the DMP Common Standard. + +It is designed to: + +- Support **information requirements imposed by funding agencies** +- Reflect **national, institutional, and thematic practices** around DMPs +- Enable reliable machine-to-machine interactions in the European research data management ecosystem + +Technically, the application profile is specified in accordance with the extension mechanisms foreseen by the DMP Common Standard and forms a core artefact of the DMP Commons as a formal description of the maDMP data structure. + +Iterative and community-driven development +------------------------------------------ + +The OSTrails Application Profile is developed **iteratively**. + +Rather than defining a fixed, one-time specification, the profile continuously evolves by consolidating requirements gathered from multiple perspectives and real-world implementations. This approach allows the AP to respond to emerging needs while maintaining internal consistency and interoperability. + +The application profile is intentionally designed as an artefact that is **by-design ready for future evolution**, both within the OSTrails project and beyond it. + +At present, the OSTrails AP is in an **early stage of development**, and its structure and content are expected to mature through successive iterations. + +Sources of requirements and inputs +---------------------------------- + +The OSTrails Application Profile is informed by a wide range of inputs, including: + +- **Funding agency DMP templates** and policy requirements +- **European and EOSC-level guidelines** and interoperability recommendations +- **National and regional DMP practices** identified through pilots +- **Institutional requirements**, including those of research-performing and research-supporting organisations +- **Thematic and domain-specific guidelines** from research communities +- **Feedback from national and thematic pilots within OSTrails** +- **Practical implementation experience** from DMP platforms and services +- **Gaps and ambiguities identified in the DMP Common Standard** when applied in operational settings + +These inputs are analysed, consolidated, and progressively incorporated into the application profile. Some of the exemplary efforts are documented in the :doc:`maDMP mappings `. + +Relationship to the DMP Common Standard +--------------------------------------- + +The OSTrails Application Profile is a **formal extension** of the :doc:`RDA DMP Common Standard (DCS) for maDMPs `. + +This means that the profile may introduce: + +- new entities, +- additional fields or attributes, +- more specific constraints on existing elements, +- clarified usage patterns for machine-actionable exchange. + +At the same time, **compatibility is a core design principle**. Every maDMP that conforms to the OSTrails Application Profile is also compliant with the broader and in a sense simpler DMP Common Standard. + +This ensures that DMPs expressed using the OSTrails AP remain interoperable with services that only support the core RDA model, while enabling richer interactions where the application profile is implemented. diff --git a/docs/commons/dmp/dmp-common-standard.rst b/docs/commons/dmp/dmp-common-standard.rst new file mode 100644 index 0000000..a793c8e --- /dev/null +++ b/docs/commons/dmp/dmp-common-standard.rst @@ -0,0 +1,72 @@ +RDA DMP Common Standard for maDMPs +================================== + +.. page-authors:: + Tomasz Miksa + Marek Suchánek + + +The **RDA DMP Common Standard for machine-actionable Data Management Plans (maDMPs)** defines a minimal, interoperable data model for representing information contained in Data Management Plans in a machine-actionable way. + +The standard provides a shared vocabulary and structure for core DMP concepts that are common across domains, funders, and infrastructures. It is designed to enable consistent interpretation and exchange of DMP information between systems, while remaining independent of specific implementations, workflows, or regional policies. + +Version and usage +----------------- + +The DMP Commons currently build on **version 1.2** of the RDA DMP Common Standard: + +- https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard/tree/v1.2 + +This version serves as the **foundational layer** for the DMP Commons and is used as the base model for higher-level specifications: :doc:`OSTrails Application Profile ` and then :doc:`API specification `. All extensions and constraints introduced by the DMP Commons are defined as additions on top of this common core, ensuring compatibility with the RDA standard. + +Scope and role within the DMP Commons +------------------------------------- + +Within the DMP Commons, the RDA DMP Common Standard: + +- Defines the **minimum set of concepts** needed to describe a DMP in a machine-actionable way +- Establishes a **shared semantic baseline** across tools and services +- Enables interoperability without constraining internal data models or system architectures + +The standard intentionally avoids domain-specific requirements or policy-driven constraints. Such specializations are addressed at higher layers (e.g. application profiles), allowing the common standard to remain stable and broadly applicable. + +.. figure:: https://raw.githubusercontent.com/RDA-DMP-Common/RDA-DMP-Common-Standard/refs/tags/v1.2/docs/diagrams/maDMP-diagram.png + :alt: RDA DMP Common Standard for maDMPs v1.2 + :target: https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard/tree/v1.2 + + RDA DMP Common Standard for maDMPs v1.2 + +Community governance and maintenance +------------------------------------ + +The RDA DMP Common Standard is developed and maintained by the community under the Research Data Alliance (RDA). Issues, discussions, and proposals related **directly to the standard itself** are handled within its established community processes. + +Relevant resources include: + + - **Specification repository**: https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard + - **Issue tracker and discussions**: https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard/issues + - **RDA Working Group page**: https://www.rd-alliance.org/groups/dmp-common-standards-wg + +These channels are the authoritative venues for proposing changes, reporting issues, and discussing the evolution of the standard. + +Contribution and future evolution +---------------------------------- + +In OSTrails and DMP Commons, we actively **collaborate with and contribute to the evolution of the RDA DMP Common Standard**. + +This collaboration is driven by practical experience gained through building the :doc:`OSTrails Application Profile ` and also API on top of the standard, as well as by identifying gaps or ambiguities that affect interoperability beyond specific infrastructures or regional contexts. + +Proposed improvements are intentionally **not limited to OSTrails, EOSC, or Europe-specific needs**, but aim to strengthen the standard for the broader international community and future versions of the specification. + +As the RDA DMP Common Standard evolves, the DMP Commons will track and align with new versions, ensuring continuity while supporting incremental adoption. + +References +---------- + +.. bibliography:: + :list: bullet + :filter: False + :keyprefix: dmp-common-standard- + :labelprefix: dmp-common-standard- + + Miksa_RDA_DMP_Common diff --git a/docs/commons/dmp/dmp-commons.rst b/docs/commons/dmp/dmp-commons.rst new file mode 100644 index 0000000..c52ae03 --- /dev/null +++ b/docs/commons/dmp/dmp-commons.rst @@ -0,0 +1,49 @@ +DMP Commons +=========== + +.. page-authors:: + Marek Suchánek + Jana Martínková + Tomasz Miksa + + +The **DMP Commons** provide a shared, reusable, and interoperable foundation for working with **machine-actionable Data Management Plans (maDMPs)** across tools and services to support the adoption of the **DMP Interoperability Framework**. They define how DMP information is structured, constrained, and exchanged, without prescribing how individual systems are internally designed or implemented. DMP Commons are primarily aimed at software developers building services that create or consume machine-actionable DMPs (maDMPs). This includes: + +- DMP platform providers, +- Other services that integrate with these platforms, as outlined in our *Architecture and Pathways*. + +In addition, DMP Commons are relevant for data stewards and other stakeholders who need to structure information about Research Data Management (RDM). + +The Commons are built as a **layered framework** consisting of a common data model, an OSTrails (i.e. Europe/EOSC) -specific application profile, and a standard API. Together, these layers enable consistent interpretation of DMP content and predictable interactions between services, regardless of their internal architectures. This approach allows platforms to evolve independently while remaining interoperable at the boundaries. In addition, we provide `maDMP mappings `_ to support the development of application profiles and to align DMP information with external standards and domain models. + +.. figure:: ostrails_dmp-commons.png + :alt: DMP Commons Layers + :align: center + :scale: 60% + + DMP Commons Layers + + +As illustrated above, the DMP Commons consist of three main components: + +- :doc:`RDA DMP Common Standard for maDMPs `: The foundational data model defining core DMP concepts and structures in a machine-actionable way. +- :doc:`OSTrails Application Profile for maDMPs `: A Europe/EOSC-specific extension of the common standard that introduces additional entities, fields, and constraints to address regional interoperability needs. +- :doc:`OSTrails maDMP API Specification `: A standardised interface for programmatically interacting with maDMPs across platforms, built on top of the common standard and compatible with the application profile. + +The primary users of the DMP Commons are **software developers, system architects, and service operators** who design or operate DMP platforms and related research data management services. Researchers are not expected to interact with the Commons directly; instead, they benefit indirectly through increased automation, reduced duplication of effort, and better reuse of DMP information across systems. + +The DMP Commons are **community-driven and evolutionary** in a sense that they are designed to continuously evolve based on community feedback and emerging needs. They build heavily on work carried out in the Research Data Alliance (RDA), including the RDA DMP Common Standard recommendation, and in turn actively contribute back to those communities. The framework is designed to support gradual adoption, while enabling full interoperability when all components are implemented. + +---- + +For the time being, the Commons consist of the following resources: + +.. toctree:: + :caption: DMP Commons Resources + :maxdepth: 1 + :titlesonly: + + DMP Common Standard for maDMPs + OSTrails Application Profile for maDMPs + OSTrails maDMP API Specification + maDMP mappings diff --git a/docs/commons/dmp/madmp-api-specification.rst b/docs/commons/dmp/madmp-api-specification.rst new file mode 100644 index 0000000..7c06b06 --- /dev/null +++ b/docs/commons/dmp/madmp-api-specification.rst @@ -0,0 +1,89 @@ +maDMP API Specification +======================= + +.. page-authors:: + Tomasz Miksa + Marek Suchánek + Vojtěch Knaisl + + +The **maDMP API specification** defines a common way to **programmatically interact with machine-actionable Data Management Plans (maDMPs)** across DMP platforms and related services. + +The API enables uniform access to DMP information and actions, even when individual platforms differ in their internal architectures, functional focus, user experience, or integrations with other systems. + +Purpose and design principles +----------------------------- + +The maDMP API is designed to: + +- Enable **standardised operations** over DMPs across platforms +- Support **machine-to-machine interoperability** in heterogeneous environments +- Decouple external interactions from internal system design +- Facilitate automation of research data management workflows + +The API focuses on *how* DMP information is accessed and manipulated, not on *how* services internally store or manage that information. This allows platforms to evolve independently while exposing a predictable and interoperable interface. + +Relationship to the data models +------------------------------- + +The maDMP API builds directly on top of the :doc:`RDA DMP Common Standard ` and uses its concepts and structures as the semantic foundation for all exchanged messages. + +The API is designed to be **flexible with respect to compatible extensions**, such as the :doc:`OSTrails Application Profile `. This means that: + +- The API can operate over DMPs expressed using the core DMP Common Standard. +- It can also be used with extended profiles, as long as they remain compatible with the common model. + +This approach allows the same API to be reused across different contexts and extensions, while preserving interoperability at the core level. + +Uniform operations across DMP platforms +--------------------------------------- + +By implementing the maDMP API, DMP platforms expose a common set of operations that can be used consistently across systems, for example: + +- searching or filtering DMPs based on various criteria, +- retrieving DMPs and their metadata, +- updating or enriching DMP information, +- creating new DMPs, +- deleting or archiving DMPs. + +These operations are performed in a unified way, independent of the platform’s specific focus, user interface, or internal integrations. + +Community governance and maintenance +------------------------------------ + +The maDMP API specification is being **developed jointly** within the `RDA Common Application Programming Interface (API) for machine-actionable Data Management Plans (maDMPs) Working Group `_. + +The working group was established during the OSTrails project and brings together experts from multiple initiatives and infrastructures to define a broadly applicable, community-endorsed API. + +Relevant resources include: + + - **Specification repository**: https://github.com/RDA-DMP-Common/common-madmp-api + - **Issue tracker and discussions**: https://github.com/RDA-DMP-Common/common-madmp-api/issues + - **RDA Working Group page**: https://www.rd-alliance.org/groups/common-application-programming-interface-api-for-machine-actionable-data-management-plans-madmps + +Documentation and versioning +---------------------------- + +The API is documented using OpenAPI, with rendered documentation available at: + +- **OpenAPI documentation**: + https://rda-dmp-common.github.io/common-madmp-api/ + +Currently, the API specification is at **version 0.1.0**, representing an early stage of development. Future versions will evolve based on community feedback, implementation experience, and emerging needs. The current specification reflects the consensus of the working group and is being tested by participating tools. Future updates will incorporate feedback from the community and ensure broad compatibility. + +Involved tools +-------------- + +The development and adoption of the maDMP API involve collaboration with several DMP platforms and services, including: + +* Argos +* DAMAP +* DMPonline +* DMP OPIDoR +* DMP Tool +* Data Stewardship Wizard (DSW) +* DataPLAN +* FAIR Wizard +* OpenCDMP + +These tools will implement the API endpoints to enable interoperability and integration with other services such as data repositories, FAIR assessment tools, and virtual research environments. diff --git "a/docs/commons/dmp/mappings/Austrian-FWF\342\200\223maDMP-mapping.rst" "b/docs/commons/dmp/mappings/Austrian-FWF\342\200\223maDMP-mapping.rst" new file mode 100644 index 0000000..e2ba08a --- /dev/null +++ "b/docs/commons/dmp/mappings/Austrian-FWF\342\200\223maDMP-mapping.rst" @@ -0,0 +1,285 @@ +Austrian FWF – maDMP mapping +============================ + +We performed a mapping for each section using te Evaluation Rubric of the FWF template. + +Section: I General Information +------------------------------- + +.. list-table:: Subsection: I.1 Administrative information + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Provide information such as name of principal investigator, FWF project number, and version of DMP + - Contains the minimal information required to identify the principal investigator and the references of the project as well as the version of the DMP. + - dmp/contact/name, + dmp/project/number, + dmp/project/description, + dmp/project/funding/funder_id, + dmp/project/funding/grant_id, + - + +.. list-table:: Subsection: I.2 Data management responsibilities and resources + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Who (for example, role, position, and institution) will be responsible for data management? + - Clearly outlines the roles and responsibilities for data management, naming responsible individual(s) and clearly indicates who is responsible for day-to-day implementation and adjustments to the DMP. + - contributor/contributor_id, + contributor/role, + contributor/affiliation, + contributor/name, + - + * - What resources will be dedicated to data management and ensuring that data will be FAIR (Findable, Accessible, Interoperable, Re-usable)? + - Provides clear estimates of the resources and costs (for example, staff time and repository charges) that will be dedicated to data management and ensuring that data will be FAIR and describes how these costs will be covered. Alternatively, there is a statement that no additional resources are needed. + - cost/description, + cost/value, + cost/title, + - + +Section: II Data Characteristics +--------------------------------- + +.. list-table:: Subsection: II.1 Data description and collection or re-use of existing data + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - How will new data be collected or produced and/or how will existing data be re-used? + - Gives clear details of where the existing data come from and how new data will be collected or produced. It clearly explains methods and software used. + - + - dataset/methodology + * - What data (types, formats, and, volumes) will be collected or produced? + - Explains, if existing data are re-used, how these data will be accessed and any constraints on their re-use. + - dataset/is_reused, + dataset/distribution + /data_access, + - + * - + - Clearly describes or lists what data types will be generated (for example, numeric, textual, audio, or video) and their associated data formats. + - dataset/type , + dataset/distribution + /format + - + * - + - Explains why certain formats have been chosen and indicates if they are in open and standard format. If a proprietary format is used, it explains why. + - dataset/distribution + /description, + - dataset/distribution + /format_justification + * - + - Provides information about the estimated data volume. + - dataset/distribution/byte_size + - + + +Section: III Documentation and Data Quality +-------------------------------------------- + +.. list-table:: Subsection: III.1 Metadata and documentation + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - What metadata and documentation (for example, the methodology of data collection and way of organising the data) will accompany the data? + - Clearly outlines the metadata that will accompany the data, with reference to good practice in the community (for example, uses metadata standards where they exist). + - datset/metadata + - + * - + - Indicates how the data will be organised during the project (for example, naming conventions, version control strategy, and folder structures). + - dataset/metadata + dataset/data_quality_assurance + - + * - + - Clearly outlines the documentation needed to enable data re-use, stating where the information will be recorded (for example, a database with links to each item, a ‘readme’ text file, code books, or lab notebooks). + - + - dataset/methodology + +.. list-table:: Subsection: III.2 Data quality control + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - What data quality control measures will be used? + - Clearly describes the approach taken to ensure and document quality control in the collection of data during the lifetime of the project. + - + - dataset/methodology + +Section: IV Data Storage, Sharing, and Long-Term Preservation +-------------------------------------------------------------- + +.. list-table:: Subsection: IV.1 Data storage and backup during the research process + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - How will the data and metadata be stored and backed up during the research process? + - The location where the data and backups will be stored during the research activities. + - dataset/distribution + /host/url + - + * - + - How often backups will be performed. + - dataset/distribution + /host/backup_type + - + * - + - The use of robust, managed storage with automatic backup (for example, storage provided by the home institution). + - dataset/distribution + /host/backup_frequency, + dataset/distribution + /host/backup_type + - + * - + - Explains why institutional storage will not be used (and for what part of the data) and describes the (additional) locations, storage media, and procedures that will be used for storing and backing up data during the project. + - dataset/distribution + /host/description, + dataset/distributions + /host/url , + dataset/distribution + /access_url + - + * - How will data security and protection of sensitive data be taken care of during the research? + - How the data will be recovered in the event of a technical incident. + - dataset/distribution + /host/title, + dataset/distribution + /host/description, + - dataset/distribution + /host/recovery_plan + +.. list-table:: Subsection: IV.2 Data sharing and long-term preservation + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - How and when will the data be shared? Are there restrictions to data sharing or embargo reasons? + - Clearly describes how and when the data will be made discoverable and shared. + - dataset/distroibution/*, + dataset/distributions/host/*, + dataset/distribution + /license/start_date, + dataset/issued + - + * - In which repository will the data be archived and made available for re-use? What persistent identifier (e.g., DOI) and which usage licence (e.g., CC BY) will be used? + - Specifies a repository for data re-use and explains which persistent identifiers (PIDs) are provided for the data and under which licence the data will be made available. (see FWF Open Access Policy for Research Data). + - dataset/distribution + /host/url, + dataset/distribution + /licenselicense_ref + - + * - + - Clearly explains, if applicable, why data sharing is limited or not possible, and who can access the data under which conditions (for example, only members of certain communities or via a sharing agreement). + - dataset/security_and _privacy, + dataset/personal_data, + dataset/sensitive_data + - + * - + - Explains what actions will be taken to overcome or to minimise data sharing restrictions. + - dataset/distribution + /license/start_date + - + * - What methods and software tools are needed to access and use the data? + - Clearly indicates which specific tools or software (for example, specific scripts, codes, or algorithms developed during the project, version of the software) potential users may need to access, interpret, and (re-) use the data. + - dataset/technical_resouce/* + - + * - + - Provides details on how the data, accompanying documentation, and any other required technology such as copies of software in specific versions will be archived in the long term. + - dataset/distribution/host/url + - + * - How will data for preservation be selected, and where will the data be preserved long-term? + - Provides details of which (versions of) data and accompanying documentation will be retained or destroyed, and explains the rationale (for example, contractual, legal requirements, or regulatory purposes). + - dataset/preservation_statement + - dmp/related_policy + * - + - Provides details of what data collected or created in the project will be preserved in the long term and clearly indicates for how long. This should be in alignment with institutional, or national policies and/or legislation, or community standards. + - dataset/preservation_statement, + dataset/distribution + /license/start_date, + dataset/data_quality_assurance + - + +Section: V Legal and Ethical Aspects +------------------------------------- + +.. list-table:: Subsection: V.1 Legal aspects + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - How will legal issues, such as intellectual property rights and ownership, be managed? What legislation is applicable? + - Clearly explains who will have the rights to control access to the data. + - dataset/creator/\*, + dataset/distribution + /license/license_ref, + dataset/data_quality_assurance + - + * - + - Explains for multi-partner projects and multiple data owners how these matters are addressed in the consortium agreement. + - dataset/distribution + /license/license_ref, + dataset/data_quality_assurance + - + * - + - Clearly explains, if applicable, how intellectual property rights will be managed. + - + - dataset/distribution + /property_rights_explanation + * - + - Indicates, if applicable, whether there are any restrictions on the re-use of third-party data. + - + - dataset/distribution + /restriction_explanation + * - If personal data are processed, how will compliance with legislation on personal data and on security be ensured? + - Clearly indicates if personal data will be collected/used as part of the project, and, if applicable, how compliance with applicable legislation will be ensured (for example, by gaining informed consent, considering encryption, anonymisation, or pseudonymisation). + - dataset/personal_data + - + +.. list-table:: Subsection: V.2 Ethical aspects + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - What ethical issues and codes of conduct are there, and how will they be taken into account? + - Provides details of what ethical issues have been considered that may affect data storage, sharing, and/or preservation, and demonstrates that adequate measures are in place to manage ethical requirements. + - dataset/security_and_privacy + - + * - + - Mentions, if applicable, whether ethical review is being pursued. If ethical approval has been obtained, refers to the relevant committee and documents. + - ethical_issues_exist, + ethical_issues_report, + ethical_issues_description + - + * - + - Refers to relevant ethical guidelines and/or codes of conduct or alternatively provides a clear statement that explains why ethical issues have not been considered. + - + - dmp/related_policy diff --git a/docs/commons/dmp/mappings/Science-Europe-maDMP-mapping.rst b/docs/commons/dmp/mappings/Science-Europe-maDMP-mapping.rst new file mode 100644 index 0000000..5340109 --- /dev/null +++ b/docs/commons/dmp/mappings/Science-Europe-maDMP-mapping.rst @@ -0,0 +1,389 @@ +Science Europe maDMP mapping +============================ + +We performed a mapping for each section using te Evaluation Rubric of the Science Europe template. + +Section: GENERAL INFORMATION +----------------------------- + +.. list-table:: Subsection: Administrative information + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Provide information such as name of applicant, project number (if applicable), funding programme, version of DMP. + - This section contains the minimal information required to identify the applicant and the references of the project. + - dmp/contact/name, + dmp/project/number, + dmp/project/description, + dmp/project/funding/funder_id, + dmp/project/funding/grant_id + - + +Section: 1 DATA DESCRIPTION AND COLLECTION OR RE-USE OF EXISTING DATA +---------------------------------------------------------------------- + +.. list-table:: Subsection: 1a How will new data be collected or produced and/or how will existing data be re-used? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain which methodologies or software will be used if new data are collected or produced. + - Gives clear details of where the existing data come from and how new data will be collected or produced. It clearly explains methods and software used. + - + - dataset/methodology + * - State any constraints on re-use of existing data if there are any. + - Explains, if existing data are re-used, how these data will be accessed and any constraints on their re-use. + - ditribution/data_access, + dmp/ethical_issues_exist, + dataset/is_reused, + dataset/security_and_privacy + - dataset/is_reused, + distribution/restriction_explanation + * - Explain how data provenance will be documented. + - Explains clearly, if applicable, why new data must be collected, rather than re-using existing data. + - dataset/data_quality_assurance + - + * - Briefly state the reasons if the re-use of any existing data sources has been considered but discarded. + - Explains clearly, if applicable, why new data must be collected, rather than re-using existing data. + - + - dataset/methodology + +.. list-table:: Subsection: 1b What data (for example the kind, formats, and volumes), will be collected or produced? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Give details on the kind of data: for example, numeric (databases, spreadsheets), textual (documents), image, audio, video, and/or mixed media. + - Clearly describes or lists what data types will be generated (for example numeric, textual, audio, or video) and their associated data formats, including, if needed, data conversion strategies. + - dataset/type, + dataset/description + - + * - Give details on the data format: the way in which the data is encoded for storage, often reflected by the filename extension (for example pdf, xls, doc, txt, or rdf). + - Explains why certain formats have been chosen and indicates if they are in open and standard format. If a proprietary format is used, it explains why + - dataset/format + distribution/format + - + * - Justify the use of certain formats. For example, decisions may be based on staff expertise within the host organisation, a preference for open formats, standards accepted by data repositories, widespread usage within the research community, or on the software or equipment that will be used. + - Explains why certain formats have been chosen and indicates if they are in open and standard format. If a proprietary format is used, it explains why + - distribution/description + - distribution/format_justification + * - Give preference to open and standard formats as they facilitate sharing and long-term re-use of data (several repositories provide lists of such ‘preferred formats’). + - Explains why certain formats have been chosen and indicates if they are in open and standard format. If a proprietary format is used, it explains why + - distribution/format + - + * - Give details on the volumes (they can be expressed in storage space required (bytes), and/or in numbers of objects, files, rows, and columns). + - Provides information about the estimated data volume. + - distribution/byte_size + - + + +Section: 2 DOCUMENTATION AND DATA QUALITY +------------------------------------------ + +.. list-table:: Subsection: 2a What metadata and documentation (for example the methodology of data collection and way of organising data) will accompany the data? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Indicate which metadata will be provided to help others identify and discover the data. + - Clearly outlines the metadata that will accompany the data, with reference to good practice in the community (for example uses metadata standards where they exist). + - dataset/metadata + - + * - Indicate which metadata standards (for example DDI, TEI, EML, MARC, CMDI) will be used. + - Clearly outlines the documentation needed to enable data re-use, stating where the information will be recorded (for example a database with links to each item, a ‘readme’ text file, file headers, code books, or lab notebooks). + - dataset/metadata + - + * - Use community metadata standards where these are in place. + - + - dataset/metadata + - + * - Indicate how the data will be organised during the project mentioning, for example, conventions, version control, and folder structures. Consistent, well-ordered research data will be easier to find, understand, and reuse. + - Indicates how the data will be organised during the project (for example naming conventions, version control strategy and folder structures). + - dataset/metadata, + dataset/keyword, + dataset/data_quality_assurance + - + * - Consider what other documentation is needed to enable re-use. This may include information on the methodology used to collect the data, analytical and procedural information, definitions of variables, units of measurement, and so on. + - + - + - dataset/methodology + * - Consider how this information will be captured and where it will be recorded (for example in a database with links to each item, a ’readme’ text file, file headers, code books, or lab notebooks). + - + - + - dataset/metadata/description, + distribution/host/* + +.. list-table:: Subsection: 2b What data quality control measures will be used? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain how the consistency and quality of data collection will be controlled and documented. This may include processes such as calibration, repeated samples or measurements, standardised data capture, data entry validation, peer review of data, or representation with controlled vocabularies. + - Clearly describes the approach taken to ensure and document quality control in the collection of data during the lifetime of the project. + - dataset/data_quality_assurance + - + + +Section: 3 STORAGE AND BACKUP DURING THE RESEARCH PROCESS +---------------------------------------------------------- + +.. list-table:: Subsection: 3a How will data and metadata be stored and backed up during the research? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Describe where the data will be stored and backed up during research activities and how often the backup will be performed. It is recommended to store data in least at two separate locations. + - Clearly (even if briefly) describes: + the location where the data and backups will be stored during the research activities. + how often backups will be performed. + the use of robust, managed storage with automatic backup (for example storage provided by the home institution). + - host/backup_type + host/backup_frequency + - + * - Give preference to the use of robust, managed storage with automatic backup, such as provided by IT support services of the home institution. Storing data on laptops, stand-alone hard drives, or external storage devices such as USB sticks is not recommended. + - Explains why institutional storage will not be used (and for what part of the data) and describes the (additional) locations, storage media, and procedures that will be used for storing and backing up data during the project. + - dataset/distribution/host/* + - + + +.. list-table:: Subsection: 3b How will data security and protection of sensitive data be taken care of during the research? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain how the data will be recovered in the event of an incident. + - Clearly explains + how the data will be recovered in the event of an incident. + - + - host/description + host/data_recovery_explanation + * - Explain who will have access to the data during the research and how access to data is controlled, especially in collaborative partnerships. + - Clearly explains + Who will have access to the data during the research. + - distribution/data_access + distribution/licence + - distribution/restriction_explanation + * - Consider data protection, particularly if your data is sensitive (for example containing personal data, politically sensitive information, or trade secrets). Describe the main risks and how these will be managed. + - which institutional and/or national data protection policies are in place and provides a link to where they can be accessed. + - dataset/security_and_privacy + dataset/distribution/host/licence + - distribution/restriction_explanation + dmp/related_policies + * - Explain which institutional data protection policies are in place. + - Clearly describes the additional security measures (in terms of physical security, network security, and security of computer systems and files) that will be taken to ensure that stored and transferred data are safe, when sensitive data are involved (for example personal data, politically sensitive information, or trade secrets). + - dataset/security_and_privacy + dataset/distribution/host/licence + - distribution/restriction_explanation + dmp/related_policies + + + + +Section: 4 LEGAL AND ETHICAL REQUIREMENTS, CODES OF CONDUCT +------------------------------------------------------------ + +.. list-table:: Subsection: 4a If personal data are processed, how will compliance with legislation on personal data and security be ensured? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Ensure that when dealing with personal data, data protection laws (for example GDPR) are complied with: Gain informed consent for preservation and/or sharing of personal data. + - Clearly indicates if personal data will be collected/used as part of the project, and, if applicable, how compliance with applicable legislation will be ensured (for example by gaining informed consent, considering encryption, anonymisation, or pseudonymisation). + - dataset/security_and_privacy + - distribution/property_rights_explanation + +.. list-table:: Subsection: 4b How will other legal issues, such as intellectual property rights and ownership, be managed? What legislation is applicable? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain who will be the owner of the data, meaning who will have the rights to control access: + - + - contributor/role + - + * - Indicate whether intellectual property rights (for example Database Directive, sui generis rights) are affected. If so, explain which and how will they be dealt with. + - + - + - distribution/property_rights_explanation + * - Indicate whether there are any restrictions on the re-use of third-party data. + - + - distribution/data_access + distribution/licence + - distribution/restriction_explanation + + +.. list-table:: Subsection: 4c What ethical issues and codes of conduct are there, and how will they be taken into account? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Consider whether ethical issues can affect how data are stored and transferred, who can see or use them, and how long they are kept. Demonstrate awareness of these aspects and respective planning. + - Provides details of what ethical issues have been considered that may affect data storage, transfer, use, sharing and/or preservation, and demonstrates that adequate measures are in place to manage ethical requirements. + - dmp/ethical_issues_exist + dmp/ethical_issues_description + dmp/ethical_issues_report + - + * - Follow the national and international codes of conducts and institutional ethical guidelines, and check if ethical review (for example by an ethics committee) is required for data collection in the research project. + - Refers to relevant ethical guidelines and/or codes of conduct or alternatively provides a clear statement that explains why ethical issues have not been considered. + - dmp/ethical_issues_exist + dmp/ethical_issues_description + dmp/ethical_issues_report + - + +Section: 5 DATA SHARING AND LONG-TERM PRESERVATION +-------------------------------------------------- + +.. list-table:: Subsection: 5a How and when will data be shared? Are there possible restrictions to data sharing or embargo reasons? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain how the data will be discoverable and shared (for example by deposit in a trustworthy data repository, indexed in a catalogue, use of a secure data service, direct handling of data requests, or use of another mechanism). + - Clearly describes how the data and/or metadata will be made discoverable and shared. + - host/title + host/url + distribution/description + distribution/data_access + - + +.. list-table:: Subsection: 5b How will data for preservation be selected, and where data will be preserved longterm (for example a data repository or archive)? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Indicate what data must be retained or destroyed for contractual, legal, or regulatory purposes. + - Provides details of what data collected or created in the project will be preserved in the long term and clearly indicates for how long. This should be in alignment with funder, institutional, or national policies and/or legislation, or community standards. + - dataset/preservation_statement + - dmp/related_policies + * - Indicate how it will be decided what data to keep. Describe the data to be preserved long-term. + - Provides details of which (versions of) data and accompanying documentation will be retained or destroyed, and explains the rationale (for example contractual, legal requirements, or regulatory purposes). + - dataset/preservation_statement + - + * - Explain the foreseeable research uses (and/ or users) for the data. + - Provides details of how the selection is made, and what possible interest there would be for re-use (or not). + - dataset/descriptions + - + * - Indicate where the data will be deposited. If no established repository is proposed, demonstrate in the data management plan that the data can be curated effectively beyond the lifetime of the grant. It is recommended to demonstrate that the repositories policies and procedures (including any metadata standards, and costs involved) have been checked. + - Provides details on how the data, accompanying documentation, and any other required technology such as copies of software in specific versions will be archived in the long term. + - dmp/cost + dataset/preservation_statement + - + + +.. list-table:: Subsection: 5c What methods or software tools are needed to access and use data? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Indicate whether potential users need specific tools to access and (re-)use the data. Consider the sustainability of software needed for accessing the data. + - Clearly indicates which specific tools or software (for example specific scripts, codes, or algorithms developed during the project, version of the software) potential users may need to access, interpret, and (re-)use the data. + - dataset/technical_resource + - dataset/methodology + * - Indicate whether data will be shared via a repository requests handled directly, or whether another mechanism will be used? + - Provides information, if relevant, on any protocol to access the data (for example if authentication is needed or if there is a data access request procedure). + - dataset/dataset_id + - + +.. list-table:: Subsection: 5d How will the application of a unique and persistent identifier (such as a Digital Object Identifier (DOI)) to each data set be ensured? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain how the data might be re-used in other contexts. Persistent identifiers (PIDs) should be applied so that data can be reliably and efficiently located and referred to. Persistent identifiers also help to track citations and re-use + - Specifies how the data can be re-used in other contexts. + Clearly indicates if and which persistent identifiers (PIDs) are provided for all datasets, individual datasets, data collections, or subsets. If PIDs will not be used, it explains why. + - dataset/dataset_id + - dataset/methodology + +Section: 6 DATA MANAGEMENT RESPONSIBILITIES AND RESOURCES +--------------------------------------------------------- + +.. list-table:: Subsection: 6a Who (for example role, position, and institution) will be responsible for data management (i.e. the data steward)? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Outline the roles and responsibilities for data management/ stewardship activities for example data capture, metadata production, data quality, storage and backup, data archiving, and data sharing. Name responsible individual(s) where possible. + - Clearly outlines the roles and responsibilities for data management/stewardship (for example data capture, metadata production, data quality, storage and backup, data archiving, and data sharing), naming responsible individual(s) where possible. + - contributor/role + - + * - For collaborative projects, explain the co-ordination of data management responsibilities across partners + - Clearly indicates who is responsible for day-to-day implementation and adjustments to the DMP. + - contributor/role + - + * - Indicate who is responsible for implementing the DMP, and for ensuring it is reviewed and, if necessary, revised. + - Explains, for collaborative projects, the co-ordination of data management responsibilities across partners. + - contributor/role + - + * - Indicate who is responsible for implementing the DMP, and for ensuring it is reviewed and, if necessary, revised. + - + - dmp/modified + - + +.. list-table:: Subsection: 6b What resources (for example financial and time) will be dedicated to data management and ensuring that data will be FAIR (Findable, Accessible, Interoperable, Reusable)? + :class: small-table + :header-rows: 1 + + * - Question or Requirement information + - Evaluation Rubric + - DCS + - OSTrails AP + * - Explain how the necessary resources (for example time) to prepare the data for sharing/preservation (data curation) have been costed in. + - + - dmp/cost + - dataset/methodology + * - Carefully consider and justify any resources needed to deliver the data. These may include storage costs, hardware, staff time, costs of preparing data for deposit, and repository charges. + - + - dmp/cost + - + * - Indicate whether additional resources will be needed to prepare data for deposit or to meet any charges from data repositories. If yes, explain how much is needed and how such costs will be covered + - + - dmp/cost + dataset/technical_resource + - diff --git a/docs/commons/dmp/mappings/index.rst b/docs/commons/dmp/mappings/index.rst new file mode 100644 index 0000000..8706a5a --- /dev/null +++ b/docs/commons/dmp/mappings/index.rst @@ -0,0 +1,76 @@ +maDMP Mappings +============== + +.. page-authors:: + Tomasz Miksa + +Overview +-------- + +**maDMP mappings** are structured documents that translate traditional Data Management Plan (DMP) templates into a machine-actionable format based on the `RDA maDMP Common Standard (DCS) `_ and the OSTrails Application Profile (AP). These mappings are published as part of the commons to support interoperability and automation in Research Data Management (RDM). + +Purpose +------- + +The main goals of maDMP mappings are: + +* **Enable machine-actionability** + Convert narrative DMP templates into structured, interoperable formats that can be processed by software systems. + +* **Support integration with RDM services** + Facilitate connections between DMP platforms and services such as CRIS systems, repositories, and PID infrastructures. + +* **Provide a shared reference** + Publish mappings as commons so they can be reused and adapted by other projects and communities. + +Creation Process +---------------- + +The creation of maDMP mappings follows a collaborative workflow: + +1. **Select a traditional DMP template** + + * Identify the template to be converted into a machine-actionable format. + +2. **Review standards and profiles** + + * Familiarize yourself with the RDA maDMP Common Standard and the OSTrails Application Profile. Review existing mappings (e.g., Science Europe template). + +3. **Draft the mapping** + + * Map sections and fields from the traditional template to maDMP components. + * Define validation rules and controlled vocabularies (licenses, access levels, standards). + * Request additions to the OSTrails AP if no corresponding field exists. + +4. **Test usability** + + * Validate the mapping with 3–5 real projects to ensure practical applicability. + +5. **Publish as commons** + + * The final mapping becomes part of the OSTrails commons and is available for reuse. + + +Integration +----------- + +Once mappings are created, they can be integrated into DMP platforms and connected to RDM services such as: + +* CRIS systems +* Data repositories +* PID systems + +This integration enables automated workflows and ensures that DMPs remain accurate and up-to-date throughout the research lifecycle. +This work must be done by respective tool owners. The mappings are the relevant guidance for them that helps them achieve interoperability. + + +Mappings +----------- +Here we present the mappings identified for common DMP templates used across countries and thematic clusters. + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + Science Europe maDMP mapping + Austrian FWF – maDMP mapping diff --git a/docs/commons/dmp/ostrails_dmp-commons.png b/docs/commons/dmp/ostrails_dmp-commons.png new file mode 100644 index 0000000..fe6d911 Binary files /dev/null and b/docs/commons/dmp/ostrails_dmp-commons.png differ diff --git a/docs/commons/dmp/ostrails_dmp-commons.svg b/docs/commons/dmp/ostrails_dmp-commons.svg new file mode 100644 index 0000000..7bf9be0 --- /dev/null +++ b/docs/commons/dmp/ostrails_dmp-commons.svg @@ -0,0 +1,156 @@ + + + + + +DMP Common Standard for maDMPsOSTrails Application ProfileCommon maDMP APIBase CommonData ModelEOSC-ExtendedData ModelUnified Operationsfor Data Model diff --git a/docs/commons/resources.rst b/docs/commons/resources.rst index dfa09aa..efed865 100644 --- a/docs/commons/resources.rst +++ b/docs/commons/resources.rst @@ -5,141 +5,21 @@ OSTrails Commons: Resources Daniel Garijo Marek Suchánek Allyson Lister + Pablo Alarcón-Moreno This page embodies the OSTrails Commons, a collection of reusable resource according to its structure as :ref:`components `. -DMP Commons ------------ The following resources in this section are part of the DMP Commons component. -OSTrails Application Profile for maDMPs -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. toctree:: + :maxdepth: 1 + :caption: Commons Resources -OSTrails Application Profile (AP) as a tailored extension of the `RDA DMP Common Standard (DCS) for maDMPs `_ will be designed to enhance interoperability while addressing various requirements (e.g. funders). Technically, the specification of the application profile will be done as prescribed by the DCS (which will support such extensions) and will be part of the Commons as the description of data structure. - -- *Planned resource to be developed* - - -OSTrails maDMP API Specification -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -maDMP API Specification will build on top of the DSC and OSTrails AP and specify the operations and data exchange. We plan to materialize this in the form of OpenAPI specification (using the current version, currently v3.1.1. Again, this promotes adoption as OpenAPI specification not only documents the API but also provides a way to generate source code or other artifacts (e.g. tests) as well as check compliance. - -- *Planned resource to be developed* - - -SKG Commons ------------ - -The following resources in this section are part of the SKG Commons component. - -OSTrails SKG IF -^^^^^^^^^^^^^^^ - -OSTrails SGK-IF as an extension of the `RDA SKG-IF `_ will focus on Common Standard and Data Model extensions, resulting in a specification for data structures guiding the adoption. - -- *Planned resource to be developed* - - -OSTrails SKG-IF Common API -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -SKG-IF Common API will be a specification of API following identified use cases and supporting relevant operators to guide the adoption and eventually also check compliance. - -- *Planned resource to be developed* - - -FAIR Commons ------------- - -The following resources in this section are part of the FAIR Commons component. - -FAIR Assessment specifications and SHACL shapes (FTR) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -FTR is the first OWL implementation of the FAIR Reference model described in Deliverables D1.2 and D.1.4. The reference model extends W3C standards such as DCAT (https://www.w3.org/TR/vocab-dcat-3/), DQV (https://www.w3.org/TR/vocab-dqv/) and PROV (https://www.w3.org/TR/prov-o/) to describe test results, test definitions, metrics, benchmarks, algorithms, dimensions/principles and their interpretation to generate a FAIR assessment score. - -The code release includes the vocabularies, definitions, specifications in machine-readable format and a set of SHACL validation rules to ensure tests and metrics are defined according to the specification. - -- Persistent identifier: https://w3id.org/ftr/1.0.0 -- Code Repository: https://github.com/OSTrails/FAIR_assessment_output_specification/ -- Version: 1.0.0 -- Release (in GitHub): https://github.com/OSTrails/FAIR_assessment_output_specification/releases/tag/v1.0.0 -- License: CC-BY 4.0 - - -FAIR Champion -^^^^^^^^^^^^^ - -FAIR Champion is a general-purpose FAIR assessment tool intended to be used by all communities and for all digital objects. In this release, FAIR Champion is aware of the 22 FAIR Tests (below), but any test, from any provider, can be registered so long as the test generates a metadata descriptor compliant with the FAIR Reference Model defined by OSTrails. The OpenAPI interface descriptor for this release is only partially complete; the Champion has a variety of functions related to new test registration and benchmark registration that are currently pending decisions by the OSTrails project. - -- Persistent identifier: https://tools.ostrails.eu/champion/sets/ -- Code repository: https://github.com/OSTrails/FAIR-Champion -- Version: Release v1 -- Release: https://github.com/OSTrails/FAIR-Champion/releases/tag/1.0.0 -- License: MIT - - -FAIR Champion Tests -^^^^^^^^^^^^^^^^^^^ - -A set of 22 tests for FAIRness. These are generic tests for all four FAIR facets – F, A, I, R – and do not represent any specific community or digital object. All tests require the GUID of the digital object’s metadata as input. Output follows the FAIR Test Results schema (https://w3id.org/ftr/1.0.0). - -- Persistent identifier: https://tests.ostrails.eu/tests -- Code repository: https://github.com/OSTrails/FAIR-Core-Tests -- Version: Release v1 -- Release: https://github.com/OSTrails/FAIR-Core-Tests/releases/tag/1.0.0 -- License: MIT - - -FOOPS! Test and metric catalogue -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The Ontology Pitfall Scanner for FAIR is a FAIR assessment tool for vocabularies and ontologies. In this release, FOOPS! has been adapted to comply with the FTR specification. A catalog of test descriptions has been made available in https://w3id.org/foops/catalogue. The release contains the source code of the tools, as well as the machine-readable and human-readable documentation of all tests, metrics and benchmarks associated with the tool. - -- Persistent identifier: https://w3id.org/foops/catalogue -- Zenodo link (latest release): https://doi.org/10.5281/zenodo.14767999 -- Code repository: https://github.com/oeg-upm/fair_ontologies -- Version: 0.2.0 -- Release: https://github.com/oeg-upm/fair_ontologies/releases/tag/v0.2.0 -- License: Apache-2.0 - - -FAIR Data Point -^^^^^^^^^^^^^^^ - -The FAIR Data Point software is maintained by a third party (the “FAIRDataTeam”). In OSTrails we utilize the FAIR Data Point (FDP) in its configuration as an “index”, using the 16.x releases of the software suite in DockerHub. FDP Index is the first implementation of a test registry and will include many of the descriptions from the FAIR Champion and FOOPS! - -- Identifier: https://tools.ostrails.eu/fdp-index/ -- Code repository: https://github.com/FAIRDataTeam -- Version: Docker Image version 16.x -- Release: N/A -- License: MIT - - -FAIR Data Point Index Proxy -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -An early prototype of a “proxy” service that allows native DCAT records to be registered in a FAIR Data Point Index. - -- Identifier: https://tools.ostrails.eu/fdp-index-proxy -- Zenodo link (latest release) -- Code repository: https://github.com/OSTrails/FDP-Index-Proxy -- Version: Release v1.0.0 -- Release: https://github.com/OSTrails/FDP-Index-Proxy/releases/tag/v1.0.0 -- License: MIT - - -FAIRsharing Registry -^^^^^^^^^^^^^^^^^^^^ - -FAIRsharing is a registry of standards, databases, policies and FAIR assistance conceptual components. Registration of FAIR principles/dimensions, metrics, and benchmarks within FAIRsharing allows human- and machine-readable integration of the FAIR assessment components within the wider research landscape, and is key to discovery of these resources as well as for the implementation of the tests themselves via the rich metadata contained within the registry. Rather than being a specific tool release, it is the extension to FAIRsharing with the new FAIRassist registry which is relevant to the other Commons resources described in this section. - -- Identifier: https://fairsharing.org/ -- Code repository: https://github.com/FAIRsharing/fairsharing.github.io -- Version: Continuous release + DMP Commons + SKG Commons + FAIR Commons Cross-Cutting and Supporting Resources -------------------------------------- diff --git a/docs/commons/skg/mappings/Mapping-SKGIF-DDI.rst b/docs/commons/skg/mappings/Mapping-SKGIF-DDI.rst new file mode 100644 index 0000000..fc10915 --- /dev/null +++ b/docs/commons/skg/mappings/Mapping-SKGIF-DDI.rst @@ -0,0 +1,1537 @@ +Mapping between SKG Interoperability Framework and DDI 2.5 +---------------------------------------------------------- +.. page-authors:: + Katja Moilanen + + +**The SKG Interoperability Framework** enables to exchange data about six core entities and their relationships These entities are: +1. Research Product – may be literature, data, software, or other +2. Agent – may represent a Person, an Organization, or a generic Agent linked to other entities +3. Grant – describes the funding of a project +4. Venue – models a publishing gateway +5. Topic – defines terms that can be used to describe a research product +6. Data Source – represents the storage location of a research product +For more details, visit: https://skg-if.github.io/interoperability-framework/. + +**DDI 2.5** can be used to provide structured, descriptive documentation of a dataset’s content, meaning, provenance, and access. It includes metadata fields suitable for both quantitative and qualitative research data in the social, behavioral, economic, and health sciences. +For more information, visit: https://ddialliance.org/ddi-codebook_v2.5 . + + +**The mapping between SKG Interoperability Framework and DDI2.5** is intended for individuals who are familiar with DDI 2.5 but new to SKG-IF. To support this, it provides four columns related to SKG-IF: Property name (JSONPath), Type, Optional/recommended/mandatory and Description. For DDI 2.5, there is a single column: DDI 2.5 XPath (excluding Dublin Core fields). Additionally, the Notes column contains miscellaneous information about both SKG-IF and DDI 2.5. + + +Dataset as research product +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | | +| | | | identifiers for the entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | /codeBook/stdyDscr/citation/titlStmt/IDNo/@agency | Only in the case that this attribute is used for the name of the PID | +| | | | system | | e.g. DOI | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | /codeBook/stdyDscr/citation/titlStmt/IDNo | Only in the case that this element is used for the PID e.g. | +| | | | | | 10.17026/dans-xpf-5u9e | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Needed for parsing purposes; fixed to product. | information can be generated because it is always “product” | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles | Object | optional | The titles of the entity | structure, no need to map | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles.ISO 639-1 language | name of the key | ? | The name of the key, which must be ISO 639-1 | /codeBook/stdyDscr/citation/titlStmt/titl/@xml:lang | If XML file is monolingual then /codeBook/@xml:lang is used | +| code | | | language code and be the language of the content | /codeBook/stdyDscr/citation/titlStmt/parTitl/@xml:lang | | +| | | | of the value | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles.ISO 639-1 language | Array of Strings | ? | The list of the titles in the given (ISO 639-1) | /codeBook/stdyDscr/citation/titlStmt/titl | It also possible to map "titles" with the bibliographical citation if | +| code[*] | | | language, specified by the key name | /codeBook/stdyDscr/citation/titlStmt/parTitl | needed: | +| | | | | | /codeBook/stdyDscr/citation/rspStmt/biblCit | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts | Object | optional | The abstracts of the entity | structure, no need to map | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts.ISO 639-1 | name of the key | ? | The name of the key, which must be ISO 639-1 | /codeBook/stdyDscr/stdyInfo/abstract/@xml:lang | If XML file is monolingual then /codeBook/@xml:lang is used | +| language code | | | language code and be the language of the content | | | +| | | | of the value | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts.ISO 639-1 | Array of Strings | ? | The list of the abstracts in the given (ISO | /codeBook/stdyDscr/stdyInfo/abstract | | +| language code[*] | | | 639-1) language, specified by the key name | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.product_type | String | optional | The type of the product , one of the values | information can be generated because it is always “research data” | | +| | | | “research data”, “literature”, "research | | | +| | | | software", "other" | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*] | Array of Objects | optional | The array of the objects referring to entity | structure, no need to map | | +| | | | Topic | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].term | String | mandatory | The reference, (local) identifier, of the topic | /codeBook/stdyDscr/stdyInfo/subject/keyword | Even if keyword and topcClas are the best mappings, it is possible to | +| | | | relevant for this entity | /codeBook/stdyDscr/stdyInfo/subject/topcClas | map any "vocabulary field" to this e.g. | +| | | | | | /codeBook/stdyDscr/sumDscr/anlyUnit | +| | | | | | /codeBook/stdyDscr/method/dataColl/timeMeth | +| | | | | | /codeBook/stdyDscr/method/dataColl/sampProc | +| | | | | | /codeBook/stdyDscr/method/dataColl/collMode | +| | | | | | /codeBook/stdyDscr/sumDscr/dataKind | +| | | | | | /codeBook/stdyDscr/method/dataColl/resInstru | +| | | | | | | +| | | | | | | +| | | | | | DDI-C does not support references to topics (or more generally to | +| | | | | | vocabulary terms). Therefore there is no direct mapping for this | +| | | | | | field. This mapping is based on the suitable information content. | +| | | | | | Note that in SKG-IF the terms are documented using Topics entity and | +| | | | | | the related Topics entities are only referenced here using their | +| | | | | | identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].provenance | Array of Objects | recommended | The provanance information tracking the | structure, no need to map | | +| | | | software(s) used for adding topics and the trust | | | +| | | | in given relation . | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].provenance.assoc | String | mandatory | The reference, (local) identifier, of the Agent | not supported | | +| iated_with | | | responsible for adding this term to this | | | +| | | | research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].provenance.trust | Number (float) | mandatory | The trust given to the relation | not supported | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*] | Array of Objects | optional | The array of objects describing the contributors | structure, no need to map | | +| | | | and their contribution | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].by | String | mandatory | The reference (Identifier) of the agent | /codeBook/docDscr/citation/prodStmt/producer | DDI-C does not support references. Therefore there is no direct | +| | | | contributing to the research product | /codeBook/stdyDscr/citation/rspStmt/AuthEnty | mapping for this field. This mapping is based on the suitable | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId | information content. Note that in SKG-IF the contributors are | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer | documented using Agent entity and the related Agent entities are only | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector | referenced here using their identifier. | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].declared_ | Array of Strings | recommended | The reference (identifier) of the agent which is | /codeBook/docDscr/citation/prodStmt/producer/@affiliation | DDI-C does not support references. Therefore there is no direct | +| affiliations | | | affiliation of the contributor. | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation | mapping for this field. This mapping is based on the suitable | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation | information content. Note that in SKG-IF the contributor affiliations | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation | are documented using Agent entity and the related Agent entities are | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation | only referenced here using their identifier. | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].rank | Number (integer) | recommended | The rank of the agent (order of appearance e.g. | not supported | | +| | | | in the list of authors) | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].role | String | recommended | The role of the agent. The possible values are | information can be generated because it is always “author” | | +| | | | author, editor, publisher. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].contribut | Array of Strings | recommended | The contributions of the agent using CRediT | DDI-element mappings with CReciT taxonomy: | | +| ion_types[*] | | | taxonomy | /codeBook/docDscr/citation/prodStmt/producer: "Data curation" | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty: "Conceptualization", "Investigation", "Methodology", | | +| | | | | "Supervision" | | +| | | | | codeBook/stdyDscr/citation/rspStmt/othId: the mapping must be done case by case depending of the | | +| | | | | role in this work | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer: "Project administration" | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector: "Investigation" | | +| | | | | codeBook/stdyDscr/studyDevelopment/developmentActivity/participant: mapping depends of the | | +| | | | | development activity type of the participant | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*] | Array of Objects | optional | Object representing different and multiple | structure, no need to map | In the case of datasets, it is possible to only describe one | +| | | | manifestations of the same research product | | manifestation for the most recent version or the document all | +| | | | | | different versions of the same datasets as manifestations. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type | Object | recommended | The object representing the type of the | structure, no need to map | | +| | | | manifestation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.cla | String | recommended | The URL of the class identifying the entity | not applicable | | +| ss | | | (e.g., in an ontology) describing that type. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.lab | Object | recommended | The object used for documenting the labels | not applicable | | +| els | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.lab | name of the key | ? | The name of the key, which must be ISO 639-1 | No need to fill in, if there is just one manifestation for a research product. If different versions | | +| els.ISO 639-1 language code | | | language code and be the language of the content | of the dataset are described as manifestations, can be set to "Version" and use "en" as the name of | | +| | | | of the value | the key. | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.lab | Array of Strings | ? | The label describing the manifestation type. | No need to fill in, if there is just one manifestation for a research product. If different versions | | +| els.ISO 639-1 language | | | | of the dataset are described as manifestations, can be set to "Version". | | +| code[*] | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.def | String | recommended | The URL of the schema of the manifestation type, | not applicable | | +| ined_in | | | e.g., a link to the vocabulary of allowed | | | +| | | | product types. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates | Object | recommended | The object is a dictionary, the keys represent | structure, no need to map | Choose the dates suitable for your own use case. | +| | | | the type of date and the value is expressed as | | | +| | | | either a string or a list of string, where each | | | +| | | | string is compliant with the ISO 8601 datetime | | | +| | | | string. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.ac | String or Array | ? | The date of acceptance | not applicable | | +| ceptance[*] | of Strings | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.ac | String or Array | ? | The date on which a particular digital item has | not applicable | | +| cess[*] | of Strings | | been accessed by somebody. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.co | String or Array | ? | The date on which some item has been collected, | /codeBook/stdyDscr/stdyInfo/sumDscr/collDate/@date | | +| llected[*] | of Strings | | for example the data gathered by means of | | | +| | | | questionnaires. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.co | String or Array | ? | The date on which an entity has been | not applicable | | +| pyright[*] | of Strings | | copyrighted. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.co | String or Array | ? | The date on which something, for example a | not applicable | | +| rrection[*] | of Strings | | document, is corrected. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.cr | String or Array | ? | The date on which an entity has been created. | /codeBook/stdyDscr/citation/prodStmt/prodDate/@date | | +| eation[*] | of Strings | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.de | String or Array | ? | The date on which a particular endeavour, such | not applicable | | +| cision[*] | of Strings | | as a grant application, has been or will be | | | +| | | | approved or rejected by somebody. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.de | String or Array | ? | The date on which an entity has been deposited, | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/distStmt/depDate/@date | | +| posit[*] | of Strings | | for example in a library, repository, | | | +| | | | supplementary information archive, database or | | | +| | | | similar place of document or information | | | +| | | | storage. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.di | String or Array | ? | The date on which something is distributed, for | not applicable | | +| stribution[*] | of Strings | | example the date on which a preprint of a | | | +| | | | document is e-mailed to colleagues and other | | | +| | | | academics by the author(s), or the date on which | | | +| | | | a printed announcement of forthcoming theatre | | | +| | | | events is mailed to those those on the theatre’s | | | +| | | | mailing list. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.em | String or Array | ? | The date before which an entity should not be | not supported | | +| bargo[*] | of Strings | | published, or before which a press release | | | +| | | | should not be reported on. For open-access | | | +| | | | journal articles, the embargo date is the date | | | +| | | | before which availability of the open-access | | | +| | | | version of the article is restricted by the | | | +| | | | publisher, following subscription-access | | | +| | | | availability of the published work. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.mo | String or Array | ? | The date on which an entity has been modified. | /codeBook/docDscr/citation/verStmt/version/@date | | +| dified[*] | of Strings | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.pu | String or Array | ? | The date of formal issuance of a resource (e.g. | /codeBook/stdyDscr/citation/distStmt/distDate/@date | | +| blication[*] | of Strings | | a publication or a patent). | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.re | String or Array | ? | The date on which some item is received, for | not applicable | | +| ceived[*] | of Strings | | example a document being received by a | | | +| | | | publisher. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.re | String or Array | ? | The date on which an agent is requested to do | not applicable | | +| quest[*] | of Strings | | something, for example a reviewer is requested | | | +| | | | to write a review of a paper submitted to a | | | +| | | | journal for publication, or an author is | | | +| | | | requested to supply a revised version of the | | | +| | | | paper in response to the reviews received. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.re | String or Array | ? | The date on which something, for example a claim | not applicable | | +| traction[*] | of Strings | | or a journal article, is retracted. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.va | String or Array | ? | Date of validity of a resource. | not applicable | | +| lidity[*] | of Strings | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].identifi | Array of Objects | recommended | External identifiers of the manifestationt | structure, no need to map | This is not mandatory information. In the case of documenting just | +| ers[*] | | | | | the most recent version of the dataset, this information already is | +| | | | | | documented in $.identifiers[*]. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].identifi | String | mandatory | The scheme for the external identifier. | /codeBook/stdyDscr/citation/titlStmt/IDNo/@agency | Only in the case that this attribute is used for the name of the PID | +| ers[*].scheme | | | | | e.g. DOI. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].identifi | String | mandatory | The external identifier. | /codeBook/stdyDscr/citation/titlStmt/IDNo | Only in the case that this element is used for the PID e.g. | +| ers[*].value | | | | | 10.17026/dans-xpf-5u9e | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].peer_rev | Object | recommended | Whether the manifestation has undergone a peer | structure, no need to map | | +| iew | | | review. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].peer_rev | String | mandatory | The status (reviewed or not yet) of the peer- | not applicable | | +| iew.status | | | review. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].peer_rev | String | recommended | The type of peer review. Allowed values: single- | not applicable | | +| iew.description | | | blind peer review, double-blind peer review, | | | +| | | | open peer review. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].access_r | Object | recommended | The access rights of this manifestation | structure, no need to map | | +| ights | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].access_r | String | mandatory | Describes if the manifestation is open access | /codeBook/stdyDscr/dataAccs/useStmt/conditions | There is no perfect field for this in DDI2.5. All the "access | +| ights.status | | | (open), closed access (closed), under embargo | | information" fields are more like a free text fields. | +| | | | (embargoed), restricted access (restricted), or | | | +| | | | unavailable for some reason (unavailable). | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].access_r | String | recommended | Describe and qualify the specific status | /codeBook/stdyDscr/dataAccs/useStmt/restrctn | | +| ights.description | | | selected. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].licence | String | recommended | The URL of the licence specific to the | not supported | | +| | | | manifestation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].version | String | recommended | The version for a software or research data | /codeBook/docDscr/citation/verStmt/version | | +| | | | product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio | Object | optional | An object containing bibliographic information | structure, no need to map | | +| | | | about a manifestation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.i | String | optional | Issue number | not applicable | | +| ssue | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.p | Object | optional | The pages (e.g. of the book or journal) where | not applicable | | +| ages | | | the manifestation in defined | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.p | String | mandatory | The starting page | not applicable | | +| ages.first | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.p | String | mandatory | The ending page | not applicable | | +| ages.last | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.v | String | optional | Volume number (for journals, books, conferences) | not applicable | | +| olume | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.e | String | optional | The edition (for journals and books) | not applicable | | +| dition | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.n | String | optional | A number of the manifestation within Venue (e.g. | not applicable | | +| umber | | | chapter number) | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.i | String | optional | A Venue identifier for the manifestation. | /codeBook/stdyDscr/citation/distStmt/distrbtr | DDI-C does not support references. Therefore there is no direct | +| n | | | | The mapping of the field is dependent on the implementation. If metadata is harvested and published | mapping for this field. This mapping is based on the suitable | +| | | | | by a second party, then there is no mapping. | information content. Note that in SKG-IF the venue/publishing gateway | +| | | | | | is documented using Venue entity and the related Venue entities are | +| | | | | | only referenced here using their identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.h | String | optional | A Data source identifier for the manifestation. | /codeBook/stdyDscr/citation/holdings/@location | DDI-C does not support references. Therefore there is no direct | +| osting_data_source | | | | | mapping for this field. This mapping is based on the suitable | +| | | | | | information content. Note that in SKG-IF the venue/publishing gateway | +| | | | | | is documented using Venue entity and the related Venue entities are | +| | | | | | only referenced here using their identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.relevant_organisations[*] | Array of Strings | optional | Relevant Organisation identifiers associated | not applicable | | +| | | | with a Research product, in case the individual | | | +| | | | affiliations of an Agent are not available. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.funding[*] | Array of Strings | optional | Relevant Grant identifiers associated with a | /codeBook/stdyDscr/citation/prodStmt/grantNo | DDI-C does not support references. Therefore there is no direct | +| | | | Research product. | | mapping for this field. This mapping is based on the suitable | +| | | | | | information content. Note that in SKG-IF the grant is documented | +| | | | | | using Grant entity and the related Grant entities are only referenced | +| | | | | | here using their identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products | Object | optional | Related Research products, where the semantics | structure, no need to map | | +| | | | of such relationships is specified as a key. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.cites[*] | Array of Strings | optional | Research products identifiers that are cited by | In SKG publication e.g. article using a dataset tells which datasets it cites. In DDI2.5 it is other | | +| | | | a given Research product. | way around, the dataset has the information which publications are related to (using) the dataset. | | +| | | | | Therefore mapping for this field is done with element "pointing" from dataset to the publication | | +| | | | | which cites the dataset. | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_supple | Array of Strings | optional | Research products identifiers that are | /codeBook/otherMat | DDI-C does not support references. Therefore there is no direct | +| mented_by[*] | | | supplement of a given Research product. | | mapping for this field. This mapping is based on the suitable | +| | | | | | information content. Note that in SKG-IF is_supplemented_by is | +| | | | | | documented using Research Product entity and the related Research | +| | | | | | Product entities are only referenced here using their identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_docume | Array of Strings | optional | Research products identifiers that documents a | /codeBook/stdyDscr/othrStdyMat/relMat | DDI-C does not support references. Therefore there is no direct | +| nted_by[*] | | | given Research product. | | mapping for this field. This mapping is based on the suitable | +| | | | | | information content. Note that in SKG-IF is_documented_by is | +| | | | | | documented using Research Product entity and the related Research | +| | | | | | Product entities are only referenced here using their identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_new_ve | Array of Strings | optional | Research products identifiers that are prior | not applicable | | +| rsion_of[*] | | | versions of a given Research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_part_o | Array of Strings | optional | Research products identifiers that contain the | /codeBook/stdyDscr/citation/serStmt | DDI-C does not support references. Therefore there is no direct | +| f[*] | | | current Research product. | | mapping for this field. This mapping is based on the suitable | +| | | | | | information content. Note that in SKG-IF is_part_of is documented | +| | | | | | using Research Product entity and the related Research Product | +| | | | | | entities are only referenced here using their identifier. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +Related publications, related materials, other materials and series as research product +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | | +| | | | identifiers for the entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | Publication citing (cites) the dataset (related publication): | | +| | | | system | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/IDNo/@agency | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/titlStmt/IDNo/@agency | | +| | | | | | | +| | | | | Series information of the dataset (is_part_of): | | +| | | | | set value to "url" | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/IDNo | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/titlStmt/IDNo | | +| | | | | | | +| | | | | Series information of the dataset (is_part_of): | | +| | | | | /codeBook/stdyDscr/citation/serStmt/@URI | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Needed for parsing purposes; fixed to product. | information can be generated because it is always “product” | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles | Object | optional | The titles of the entity | structure, no need to map | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles.ISO 639-1 language | name of the key | ? | The name of the key, which must be ISO 639-1 | Publication citing (cites) the dataset (related publication): | If XML file is monolingual then /codeBook/@xml:lang may be used in | +| code | | | language code and be the language of the content | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl/@xml:lang | some cases | +| | | | of the value | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/parTitl/@xml:lang | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/titl/@xml:lang | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/parTitl/@xml:lang | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/titlStmt/titl/@xml:lang | | +| | | | | /codeBook/otherMat/citation/titlStmt/parTitl/@xml:lang | | +| | | | | | | +| | | | | Series information of the dataset (is_part_of): | | +| | | | | /codeBook/stdyDscr/citation/serStmt/serName/@xml:lang | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles.ISO 639-1 language | Array of Strings | ? | The list of the titles in the given (ISO 639-1) | Publication citing (cites) the dataset (related publication): | | +| code[*] | | | language, specified by the key name | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/titl | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/parTitl | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/titl | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/parTitl | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/titlStmt/titl | | +| | | | | /codeBook/otherMat/citation/titlStmt/parTitl | | +| | | | | | | +| | | | | Series information of the dataset (is_part_of): | | +| | | | | /codeBook/stdyDscr/citation/serStmt/serName | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts | Object | optional | The abstracts of the entity | structure, no need to map | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts.ISO 639-1 | name of the key | ? | The name of the key, which must be ISO 639-1 | Series information of the dataset (is_part_of): | If XML file is monolingual then /codeBook/@xml:lang is used | +| language code | | | language code and be the language of the content | /codeBook/stdyDscr/citation/serStmt/serInfo/@xml:lang | | +| | | | of the value | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts.ISO 639-1 | Array of Strings | ? | The list of the abstracts in the given (ISO | Series information of the dataset (is_part_of): | | +| language code[*] | | | 639-1) language, specified by the key name | /codeBook/stdyDscr/citation/serStmt/serInfo | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.product_type | String | optional | The type of the product , one of the values | information can be generated because it is either “literature” e.g. related publication or "other" | | +| | | | “research data”, “literature”, "research | e.g. other material, series information | | +| | | | software", "other" | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*] | Array of Objects | optional | The array of the objects referring to entity | structure, no need to map | | +| | | | Topic | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].term | String | mandatory | The reference, (local) identifier, of the topic | not applicable | | +| | | | relevant for this entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].provenance | Array of Objects | recommended | The provanance information tracking the | structure, no need to map | | +| | | | software(s) used for adding topics and the trust | | | +| | | | in given relation . | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].provenance.assoc | String | mandatory | The reference, (local) identifier, of the Agent | not applicable | | +| iated_with | | | responsible for adding this term to this | | | +| | | | research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.topics[*].provenance.trust | Number (float) | mandatory | The trust given to the relation | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*] | Array of Objects | optional | The array of objects describing the contributors | structure, no need to map | | +| | | | and their contribution | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].by | String | mandatory | The reference (Identifier) of the agent | Publication citing (cites) the dataset (related publication): | DDI-C does not support references. Therefore there is no direct | +| | | | contributing to the research product | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty | mapping for this field. This mapping is based on the suitable | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId | information content. Note that in SKG-IF the contributors are | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer | documented using Agent entity and the related Agent entities are only | +| | | | | | referenced here using their identifier. | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].declared_ | String | recommended | The reference (identifier) of the agent which is | Publication citing (cites) the dataset (related publication): | DDI-C does not support references. Therefore there is no direct | +| affiliations | | | affiliation of the contributor. | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation | mapping for this field. This mapping is based on the suitable | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation | information content. Note that in SKG-IF the contributor affiliations | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation | are documented using Agent entity and the related Agent entities are | +| | | | | | only referenced here using their identifier. | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].rank | Number (integer) | recommended | The rank of the agent (order of appearance e.g. | not applicable | | +| | | | in the list of authors) | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].role | String | recommended | The role of the agent. The possible values are | information can be generated because it is always “author” | | +| | | | author, editor, publisher. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].contribut | Array of Strings | recommended | The contributions of the agent using CRediT | DDI-element mappings with CReciT taxonomy: | | +| ion_types[*] | | | taxonomy | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty: the mapping must be done | | +| | | | | case by case depending of the role in this work | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId: the mapping must be done | | +| | | | | case by case depending of the role in this work | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer: "Project administration" | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty: the mapping must be done | | +| | | | | case by case depending of the role in this work | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId: the mapping must be done case | | +| | | | | by case depending of the role in this work | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer: "Project administration" | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty: the mapping must be done case by case | | +| | | | | depending of the role in this work | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId: the mapping must be done case by case depending | | +| | | | | of the role in this work | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer: "Project administration" | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*] | Array of Objects | optional | Object representing different and multiple | structure, no need to map | | +| | | | manifestations of the same research product | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type | Object | recommended | The object representing the type of the | structure, no need to map | | +| | | | manifestation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.cla | String | recommended | The URL of the class identifying the entity | not applicable | | +| ss | | | (e.g., in an ontology) describing that type. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.lab | Object | recommended | The object used for documenting the labels | not applicable | | +| els | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.lab | name of the key | ? | The name of the key, which must be ISO 639-1 | No need to fill in, if there is just one manifestation for a research product. If different versions | | +| els.ISO 639-1 language code | | | language code and be the language of the content | of the related publication / related material / other material are described as manifestations, use | | +| | | | of the value | e.g. "en" as the name of the key (language). | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.lab | Array of Strings | ? | The label describing the manifestation type. | No need to fill in, if there is just one manifestation for a research product. If different versions | | +| els.ISO 639-1 language | | | | of the related publication / related material / other material are described as manifestations, can | | +| code[*] | | | | be set to "Version" and use "en" as the name of the key. | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].type.def | String | recommended | The URL of the schema of the manifestation type, | not applicable | | +| ined_in | | | e.g., a link to the vocabulary of allowed | | | +| | | | product types. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates | Object | recommended | The object is a dictionary, the keys represent | structure, no need to map | | +| | | | the type of date and the value is expressed as | | | +| | | | either a string or a list of string, where each | | | +| | | | string is compliant with the ISO 8601 datetime | | | +| | | | string. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.ac | String or Array | ? | The date of acceptance | not applicable | | +| ceptance[*] | of String | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.ac | String or Array | ? | The date on which a particular digital item has | not applicable | | +| cess[*] | of String | | been accessed by somebody. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.co | String or Array | ? | The date on which some item has been collected, | not applicable | | +| llected[*] | of String | | for example the data gathered by means of | | | +| | | | questionnaires. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.co | String or Array | ? | The date on which an entity has been | not applicable | | +| pyright[*] | of String | | copyrighted. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.co | String or Array | ? | The date on which something, for example a | not applicable | | +| rrection[*] | of String | | document, is corrected. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.cr | String or Array | ? | The date on which an entity has been created. | Publication citing (cites) the dataset (related publication): | | +| eation[*] | of String | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/prodDate/@date | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/prodDate/@date | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/prodStmt/prodDate/@date | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.de | String or Array | ? | The date on which a particular endeavour, such | not applicable | | +| cision[*] | of String | | as a grant application, has been or will be | | | +| | | | approved or rejected by somebody. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.de | String or Array | ? | The date on which an entity has been deposited, | Publication citing (cites) the dataset (related publication): | | +| posit[*] | of String | | for example in a library, repository, | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/distStmt/depDate/@date | | +| | | | supplementary information archive, database or | | | +| | | | similar place of document or information | Material documenting (is_documented_by) the dataset (related material): | | +| | | | storage. | /codeBook/stdyDscr/othrStdyMat/relMat/citation/distStmt/depDate/@date | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/distStmt/depDate/@date | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.di | String or Array | ? | The date on which something is distributed, for | not applicable | | +| stribution[*] | of String | | example the date on which a preprint of a | | | +| | | | document is e-mailed to colleagues and other | | | +| | | | academics by the author(s), or the date on which | | | +| | | | a printed announcement of forthcoming theatre | | | +| | | | events is mailed to those those on the theatre’s | | | +| | | | mailing list. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.em | String or Array | ? | The date before which an entity should not be | not applicable | | +| bargo[*] | of String | | published, or before which a press release | | | +| | | | should not be reported on. For open-access | | | +| | | | journal articles, the embargo date is the date | | | +| | | | before which availability of the open-access | | | +| | | | version of the article is restricted by the | | | +| | | | publisher, following subscription-access | | | +| | | | availability of the published work. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.mo | String or Array | ? | The date on which an entity has been modified. | Publication citing (cites) the dataset (related publication): | | +| dified[*] | of String | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/verStmt/version/@date | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/verStmt/version/@date | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/verStmt/version/@date | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.pu | String or Array | ? | The date of formal issuance of a resource (e.g. | Publication citing (cites) the dataset (related publication): | | +| blication[*] | of String | | a publication or a patent). | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/distStmt/distDate/@date | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/distStmt/distDate/@date | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/distStmt/distDate/@date | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.re | String or Array | ? | The date on which some item is received, for | not applicable | | +| ceived[*] | of String | | example a document being received by a | | | +| | | | publisher. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.re | String or Array | ? | The date on which an agent is requested to do | not applicable | | +| quest[*] | of String | | something, for example a reviewer is requested | | | +| | | | to write a review of a paper submitted to a | | | +| | | | journal for publication, or an author is | | | +| | | | requested to supply a revised version of the | | | +| | | | paper in response to the reviews received. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.re | String or Array | ? | The date on which something, for example a claim | not applicable | | +| traction[*] | of String | | or a journal article, is retracted. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].dates.va | String or Array | ? | Date of validity of a resource. | not applicable | | +| lidity[*] | of String | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].identifi | Array of Objects | recommended | External identifiers of the manifestationt | structure, no need to map | | +| ers[*] | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].identifi | String | mandatory | The scheme for the external identifier. | Publication citing (cites) the dataset (related publication): | | +| ers.scheme | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo/@agency | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/IDNo/@agency | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/titlStmt/IDNo/@agency | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].identifi | String | mandatory | The external identifier. | Publication citing (cites) the dataset (related publication): | | +| ers.value | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/titlStmt/IDNo | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/IDNo | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/titlStmt/IDNo | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].peer_rev | Object | recommended | Whether the manifestation has undergone a peer | structure, no need to map | | +| iew | | | review. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].peer_rev | String | mandatory | The status (reviewed or not yet) of the | not applicable | | +| iew.status | | | peer-review. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].peer_rev | String | recommended | The type of peer review. Allowed values: | not applicable | | +| iew.description | | | single-blind peer review, double-blind peer | | | +| | | | review, open peer review. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].access_r | Object | recommended | The access rights of this manifestation | structure, no need to map | | +| ights | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].access_r | String | mandatory | Describes if the manifestation is open access | not applicable | | +| ights.status | | | (open), closed access (closed), under embargo | | | +| | | | (embargoed), restricted access (restricted), or | | | +| | | | unavailable for some reason (unavailable). | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].access_r | String | recommended | Describe and qualify the specific status | not applicable | | +| ights.description | | | selected. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].licence | String | recommended | The URL of the licence specific to the | not applicable | | +| | | | manifestation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].version | String | recommended | The version for a software or research data | Publication citing (cites) the dataset (related publication): | | +| | | | product. | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/verStmt/version | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/verStmt/version | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/verStmt/version | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio | Object | optional | An object containing bibliographic information | structure, no need to map | | +| | | | about a manifestation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.i | String | optional | Issue number | not supported | | +| ssue | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.p | Object | optional | The pages (e.g. of the book or journal) where | not supported | | +| ages | | | the manifestation in defined | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.p | String | mandatory | The starting page | not supported | | +| ages.first | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.p | String | mandatory | The ending page | not supported | | +| ages.last | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.v | String | optional | Volume number (for journals, books, conferences) | not supported | | +| olume | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.e | String | optional | The edition (for journals and books) | not supported | | +| dition | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.n | String | optional | A number of the manifestation within Venue (e.g. | not supported | | +| umber | | | chapter number) | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.i | String | optional | A Venue identifier for the manifestation. | not supported | | +| n | | | | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.manifestations[*].biblio.h | String | optional | A Data source identifier for the manifestation. | Publication citing (cites) the dataset (related publication): | | +| osting_data_source | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/holdings/@location | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/holdings/@location | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/holdings/@location | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.relevant_organisations[*] | Array of Strings | optional | Relevant Organisation identifiers associated | not applicable | | +| | | | with a Research product, in case the individual | | | +| | | | affiliations of an Agent are not available. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.funding[*] | Array of Strings | optional | Relevant Grant identifiers associated with a | Publication citing (cites) the dataset (related publication): | | +| | | | Research product. | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/prodStmt/grantNo | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products | Object | optional | Related Research products, where the semantics | structure, no need to map | | +| | | | of such relationships is specified as a key. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.cites[*] | Array of Strings | optional | Research products identifiers that are cited by | In SKG publication e.g. article using a dataset tells which datasets it cites. In DDI2.5 it is other | | +| | | | a given Research product. | way around, the dataset has the information which publications are related to (using) the dataset. | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_supple | Array of Strings | optional | Research products identifiers that are | not applicable | | +| mented_by[*] | | | supplement of a given Research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_docume | Array of Strings | optional | Research products identifiers that documents a | not applicable | | +| nted_by[*] | | | given Research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_new_ve | Array of Strings | optional | Research products identifiers that are prior | not applicable | | +| rsion_of[*] | | | versions of a given Research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.related_products.is_part_o | Array of Strings | optional | Research products identifiers that contain the | not applicable | | +| f[*] | | | current Research product. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +Person +^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | Using ExtLink element is a workaround, there is not actually a field | +| | | | identifiers for the entity | | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | | DDI2.5. | +| | | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | | does not include ExtLink | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | system | /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink/@title | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink/@title | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@title | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@title | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@title | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/ExtLink | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Field stating the kind of entity, can be agent | information can be generated because it is always “person” | DDI2.5 do not have field stating if an agent is a person or an | +| | | | (generic), person or organisation | | organization. It is possible to separate person and organisation only | +| | | | | | if considered that AuthEnty (or other contributor field) is a person | +| | | | | | when it has affiliation attribute attached. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.name | String | optional | The string containing whatever concatenation of | Dataset: | | +| | | | an Agent name(s). | /codeBook/docDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.given_name | String | optional | The given name of a Person. | not supported | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.family_name | String | optional | The family name of a Person. | not supported | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.affiliations[*] | Array of Objects | optional | All the affiliations of a Person | structure, no need to map | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.affiliations[*].affiliatio | String | mandatory | The identifier of an Organisation a Person is | Dataset: | DDI-C does not support references. Therefore there is no direct | +| n | | | affiliated with. | /codeBook/docDscr/citation/prodStmt/producer/@affiliation | mapping for this field. This mapping is based on the suitable | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation | information content. Note that in SKG-IF the contributor affiliations | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation | are documented using Agent entity and the related Agent entities are | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation | only referenced here using their identifier. | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.affiliations[*].role | String | recommended | The role that a Person had in the context of an | information can be generated because it is always “affiliate” | | +| | | | Organisation. Needed for parsing purposes; fixed | | | +| | | | to affiliate. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.affiliations[*].role.perio | Object | recommended | The time period where the Person was affiliated | not applicable | | +| d | | | with an Organisation. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.affiliations[*].role.perio | String | recommended | The start datetime of the affiliation with an | not applicable | | +| d.start | | | Organisation. The string should be compliant | | | +| | | | with the ISO 8601 datetime string. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.affiliations[*].role.perio | String | recommended | The end datetime (if any) of the affiliation | not applicable | | +| d.end | | | with an Organisation. The string should be | | | +| | | | compliant with the ISO 8601 datetime string. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + + +Affiliation of a person as Organisation +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | Using ExtLink element is a workaround, there is not actually a field | +| | | | identifiers for the entity | | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | | DDI2.5. | +| | | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | | does not include ExtLink | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | system | /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink/@title | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink/@title | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@title | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@title | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@title | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/ExtLink | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Field stating the kind of entity, can be agent | information can be generated because it is always “person” | DDI2.5 do not have field stating if an agent is a person or an | +| | | | (generic), person or organisation | | organization. It is possible to separate person and organisation only | +| | | | | | if considered that AuthEnty (or other contributor field) is a person | +| | | | | | when it has affiliation attribute attached. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.name | String | optional | The string containing whatever concatenation of | Dataset: | | +| | | | an Agent name(s). | /codeBook/docDscr/citation/prodStmt/producer/@affiliation | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.short_name | String | optional | The short name/acronym for an Organisation. | Dataset: | These fields do not support abbreviation | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/@abbr | Dataset: | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/@abbr | /codeBook/stdyDscr/citation/rspStmt/AuthEnty | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/@abbr | /codeBook/stdyDscr/citation/rspStmt/othId | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@abbr | | +| | | | | | Publication citing (cites) the dataset (related publication): | +| | | | | Publication citing (cites) the dataset (related publication): | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/Auth | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@abbr | Enty | +| | | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othI | +| | | | | Material documenting (is_documented_by) the dataset (related material): | d | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@abbr | | +| | | | | | Material documenting (is_documented_by) the dataset (related | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | material): | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@abbr | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthE | +| | | | | | nty | +| | | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId | +| | | | | | | +| | | | | | Material supplementing (is_supplemented_by) the dataset (other | +| | | | | | material): | +| | | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | +| | | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.other_names[*] | Array of Strings | optional | Other names, perhaps in different languages, | DDI2.5 includes possibility for multilingual metadata by using xml:lang attribute for all of these | | +| | | | identifying an Organisation. | fields: | | +| | | | | Dataset: | | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/@affiliation | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/@affiliation | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/@affiliation | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@affiliation | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@affiliation | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@affiliation | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@affiliation | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.website | String | optional | The website URL for an Organisation. | not supported | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.country | String | optional | The country code of an Organisation | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.type | String | optional | The types of an Organisation. | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + + +Organisation +^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | Using ExtLink element is a workaround, there is not actually a field | +| | | | identifiers for the entity | | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | | DDI2.5. | +| | | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | | does not include ExtLink | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | system | /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/fundAg/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/grantNo/ExtLink/@title | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/ExtLink/@title | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/ExtLink/@title | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/rspStmt/AuthEnty/@title | | +| | | | | /codeBook/otherMat/citation/rspStmt/othId/@title | | +| | | | | /codeBook/otherMat/citation/prodStmt/producer/@title | | +| | | | | /codeBook/otherMat/citation/prodStmt/fundAg/ExtLink/@title | | +| | | | | /codeBook/otherMat/citation/prodStmt/grantNo/ExtLink/@title | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/ExtLink | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/fundAg/ExtLink | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/grantNo/ExtLink | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/ExtLink | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/ExtLink | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/prodStmt/producer | | +| | | | | /codeBook/otherMat/citation/prodStmt/fundAg/ExtLink | | +| | | | | /codeBook/otherMat/citation/prodStmt/grantNo/ExtLink | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Field stating the kind of entity, can be agent | information can be generated because it is always “organisation” | DDI2.5 do not have field stating if an agent is a person or an | +| | | | (generic), person or organisation | | organization. It is possible to separate person and organisation only | +| | | | | | if considered that AuthEnty (or other contributor field) is a person | +| | | | | | when it has affiliation attribute attached. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.name | String | optional | The string containing whatever concatenation of | Dataset: | | +| | | | an Agent name(s). | /codeBook/docDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/fundAg | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/grantNo/@agency | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/@agency | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/@agency | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/prodStmt/producer | | +| | | | | /codeBook/otherMat/citation/prodStmt/fundAg | | +| | | | | /codeBook/otherMat/citation/prodStmt/grantNo/@agency | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.short_name | String | optional | The short name/acronym for an Organisation. | Dataset: | | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/@abbr | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/@abbr | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/@abbr | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant/@abbr | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/fundAg/@abbr | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/@abbr | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg/@abbr | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/@abbr | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg/@abbr | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@abbr | | +| | | | | /codeBook/otherMat/citation/prodStmt/fundAg/@abbr | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.other_names[*] | Array of Strings | optional | Other names, perhaps in different languages, | DDI2.5 includes possibility for multilingual metadata by using xml:lang attribute for all of these | | +| | | | identifying an Organisation. | fields: | | +| | | | | Dataset: | | +| | | | | /codeBook/docDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/fundAg | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/grantNo/@agency | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/fundAg | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/prodStmt/grantNo/@agency | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMatl/citation/prodStmt/fundAg | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/grantNo/@agency | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/prodStmt/producer | | +| | | | | /codeBook/otherMat/citation/prodStmt/fundAg | | +| | | | | /codeBook/otherMat/citation/prodStmt/grantNo/@agency | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.website | String | optional | The website URL for an Organisation. | not supported | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.country | String | optional | The country code of an Organisation | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.type | String | optional | The types of an Organisation. | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +Agent (not known if it is Person or Organization) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | Using ExtLink element is a workaround, there is not actually a field | +| | | | identifiers for the entity | | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | | DDI2.5. | +| | | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | | does not include ExtLink | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | system | /codeBook/docDscr/citation/prodStmt/producer/ExtLink/@title | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink/@title | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink/@title | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink/@title | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink/@title | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink/@title | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink/@title | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink/@title | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty/@title | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId/@title | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer/@title | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | Dataset: | Using ExtLink element is a workaround, there is not actually a field | +| | | | | /codeBook/docDscr/citation/prodStmt/producer/ExtLink | for Persistent Identifiers for any Agent, Person or Organization in | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty/ExtLink | DDI2.5. | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId/ExtLink | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer/ExtLink | does not include ExtLink | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector/ExtLink | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer/ExtLink | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId/ExtLink | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer/ExtLink | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Field stating the kind of entity, can be agent | information can be generated because it is always “agent” | | +| | | | (generic), person or organisation | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.name | String | optional | The string containing whatever concatenation of | Dataset: | | +| | | | an Agent name(s). | /codeBook/docDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/citation/prodStmt/producer | | +| | | | | /codeBook/stdyDscr/method/dataColl/dataCollector | | +| | | | | /codeBook/stdyDscr/studyDevelopment/developmentActivity/participant | | +| | | | | | | +| | | | | Publication citing (cites) the dataset (related publication): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relPubl/citation/citation/prodStmt/producer | | +| | | | | | | +| | | | | Material documenting (is_documented_by) the dataset (related material): | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/stdyDscr/othrStdyMat/relMat/citation/citation/prodStmt/producer | | +| | | | | | | +| | | | | Material supplementing (is_supplemented_by) the dataset (other material): | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/AuthEnty | | +| | | | | /codeBook/otherMat/citation/citation/rspStmt/othId | | +| | | | | /codeBook/otherMat/citation/citation/prodStmt/producer | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + + + +Grant +^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.grant_number | String | recommended | Unique code identifying the Grant at the funder. | /codeBook/stdyDscr/citation/prodStmt/grantNo | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map | | +| | | | identifiers for the entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | not supported | | +| | | | system | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | not supported | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Needed for parsing purposes; fixed to grant. | information can be generated because it is always “grant” | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles | Object | optional | The titles of the entity | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles.ISO 639-1 language | name of the key | ? | The name of the key, which must be ISO 639-1 | not applicable | | +| code | | | language code and be the language of the content | | | +| | | | of the value | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.titles.ISO 639-1 language | Array of Strings | ? | The list of the titles in the given (ISO 639-1) | not applicable | | +| code[*] | | | language, specified by the key name | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts | Object | optional | The abstracts of the entity | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts.ISO 639-1 | name of the key | ? | The name of the key, which must be ISO 639-1 | not applicable | | +| language code | | | language code and be the language of the content | | | +| | | | of the value | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.abstracts.ISO 639-1 | Array of Strings | ? | The list of the abstracts in the given (ISO | not applicable | | +| language code[*] | | | 639-1) language, specified by the key name | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.acronym | String | optional | The acronym of the grant | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.funding_agency | String | optional | The reference (identifier) of an agent | /codeBook/stdyDscr/citation/prodStmt/grantNo/@agency | | +| | | | (Organisation) funding the Grant. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.funding_stream | String | optional | The funding stream of the Grant e.g. Horizon | not applicable | | +| | | | Europe | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.currency | String | optional | Currency of the funded amount. Mandatory if | not applicable | | +| | | | funded_amount is provided) | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.funded_amount | Numeric | optional | Amount funded | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.keywords[*] | Array of Strings | optional | Keywords | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.duration | Object | optional | Duration of the Grant | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.duration.start | String | mandatory | Start date | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.duration.end | String | optional | End date | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.website | String | optional | The URL of the funded project website. | not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.beneficiaries[*] | Array of Strings | optional | The references (identifiers) of the Organization | not applicable | | +| | | | Agents funded by the Grant | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*] | Array of Objects | optional | The array of objects describing the contributors | structure, no need to map | | +| | | | and their contribution | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].by | String | mandatory | The reference (Identifier) of the agent | not applicable | | +| | | | contributing to the grant | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].declared_ | Array of Strings | recommended | The reference (identifier) of the agent which is | not applicable | | +| affiliations[*] | | | affiliation of the contributor. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].role[*] | Array of Strings | recommended | The role of the agent. SCoro project roles: | not applicable | | +| | | | co-applicant, lead applican, project leader, | | | +| | | | project manager, project member, workpackage | | | +| | | | leader | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +Venue +^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. |   | +| | | | use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map |   | +| | | | identifiers for the entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | If the contents of the URI attribute are used as the identifier then this should be set to "url" |   | +| | | | system | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | /codeBook/stdyDscr/citation/distStmt/distrbtr/@URI |   | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Needed for parsing purposes; fixed to venue | information can be generated because it is always “venue” |   | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.name | String | optional | The name of a Venue. | /codeBook/stdyDscr/citation/distStmt/distrbtr |   | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.acronym | String | optional | Acronym used by a Venue. | /codeBook/stdyDscr/citation/distStmt/distrbtr/@abbr |   | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.type | String | optional | The type of a Venue. Allowed values: journal, | Most of the times this value would be set to "repository" |   | +| | | | conference, book, repository, other, unknown | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.series | String | optional | The name of the conference or book series. | not applicable | The desciption of the field says that it is meant for the venues of | +| | | | | | type "conference" or "book" | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.access_rights | Object | recommended | The access right for the specific journal. | not applicable | The desciption of the field says that it is meant for the venues of | +| | | | | | type "journal" | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.access_rights.status | String | mandatory | The description if the journal is open access | not applicable | The desciption of the field says that it is meant for the venues of | +| | | | (open), closed access (closed), or hybrid | | type "journal" | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.access_rights.description | String | recommended | Describe and qualify the specific status | not applicable | The desciption of the field says that it is meant for the venues of | +| | | | selected. | | type "journal" | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.creation_date | String | optional | The date of creation of a Venue. | not applicable |   | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*] | Array of Objects | optional | The array of objects describing the contributors | not applicable |   | +| | | | and their contribution | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].by | String | mandatory | The reference (Identifier) of the agent | not applicable |   | +| | | | contributing to the research Venue. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.contributions[*].role | String | recommended | The role of the agent. The possible values are | not applicable |   | +| | | | editor, publisher. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + + +Topic when collected from DDI2.5 files +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +| $.local_identifier | String | mandatory | An unique identifier in SKG, it is suggested to | The value of this field is implementation-dependent. | When topic information is collected from DDI2.5, it is quite likely | +| | | | use URL as identifier | | that "on-the-fly" local identifiers will be used. | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*] | Array of Objects | recommended | The array of the objects representing external | structure, no need to map |   | +| | | | identifiers for the entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].scheme | String | mandatory | The scheme/name of the external identifier | | Using ExtLink element is a workaround, there is not actually a field | +| | | | system | /codeBook/stdyDscr/stdyInfo/subject/keyword/ExtLink/@title | for (Persistent) Identifiers | +| | | | | /codeBook/stdyDscr/stdyInfo/subject/topcClas/ExtLink/@title | Even if keyword and topcClas are the best mappings, it is possible to | +| | | | | | map any "vocabulary field" to this e.g. | +| | | | | | /codeBook/stdyDscr/sumDscr/anlyUnit/ExtLink/@title | +| | | | | | /codeBook/stdyDscr/method/dataColl/timeMeth/ExtLink/@title | +| | | | | | /codeBook/stdyDscr/method/dataColl/sampProc/ExtLink/@title | +| | | | | | /codeBook/stdyDscr/method/dataColl/collMode/ExtLink/@title | +| | | | | | /codeBook/stdyDscr/sumDscr/dataKind/ExtLink/@title | +| | | | | | /codeBook/stdyDscr/method/dataColl/resInstru/ExtLink/@title | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.identifiers[*].value | String | mandatory | The external identifier | | Even if keyword and topcClas are the best mappings, it is possible to | +| | | | | /codeBook/stdyDscr/stdyInfo/subject/keyword/ExtLink | map any "vocabulary field" to this e.g. | +| | | | | /codeBook/stdyDscr/stdyInfo/subject/topcClas/ExtLink | /codeBook/stdyDscr/sumDscr/anlyUnit/ExtLink | +| | | | | | /codeBook/stdyDscr/method/dataColl/timeMeth/ExtLink | +| | | | | | /codeBook/stdyDscr/method/dataColl/sampProc/ExtLink | +| | | | | | /codeBook/stdyDscr/method/dataColl/collMode/ExtLink | +| | | | | | /codeBook/stdyDscr/sumDscr/dataKind/ExtLink | +| | | | | | /codeBook/stdyDscr/method/dataColl/resInstru/ExtLink | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.entity_type | String | mandatory | Needed for parsing purposes; fixed to topic. | information can be generated because it is always “topic” | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.labels | Object | optional | Labels (terms) | structure, no need to map | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.labels.ISO 639-1 language | name of the key | ? | The name of the key, which must be ISO 639-1 | | Even if keyword and topcClas are the best mappings, it is possible to | +| code | | | language code and be the language of the content | /codeBook/stdyDscr/stdyInfo/subject/keyword/@xml:lang | map any "vocabulary field" to this e.g. | +| | | | of the value | /codeBook/stdyDscr/stdyInfo/subject/topcClas/@xml:lang | /codeBook/stdyDscr/sumDscr/anlyUnit/@xml:lang | +| | | | | | /codeBook/stdyDscr/method/dataColl/timeMeth/@xml:lang | +| | | | | | /codeBook/stdyDscr/method/dataColl/sampProc/@xml:lang | +| | | | | | /codeBook/stdyDscr/method/dataColl/collMode/@xml:lang | +| | | | | | /codeBook/stdyDscr/sumDscr/dataKind/@xml:lang | +| | | | | | /codeBook/stdyDscr/method/dataColl/resInstru/@xml:lang | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| $.labels.ISO 639-1 language | Array of Strings | ? | Label describing a Topic in the given (ISO | | Even if keyword and topcClas are the best mappings, it is possible to | +| code[*] | | | 639-1) language, specified by the key name | /codeBook/stdyDscr/stdyInfo/subject/keyword | map any "vocabulary field" to this e.g. | +| | | | | /codeBook/stdyDscr/stdyInfo/subject/topcClas | /codeBook/stdyDscr/sumDscr/anlyUnit | +| | | | | | /codeBook/stdyDscr/method/dataColl/timeMeth | +| | | | | | /codeBook/stdyDscr/method/dataColl/sampProc | +| | | | | | /codeBook/stdyDscr/method/dataColl/collMode | +| | | | | | /codeBook/stdyDscr/sumDscr/dataKind | +| | | | | | /codeBook/stdyDscr/method/dataColl/resInstru | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ + +Data source +^^^^^^^^^^^^ ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +| Property JSONPath | Type | Optional/Recommended | Description | DDI 2.5 XPath (Dublin Core fields excluded) | Notes | +| | | /Mandatory | | | | ++==============================+==================+======================+==================================================+======================================================================================================+=======================================================================+ +|$.local_identifier |String |mandatory |An unique identifier in SKG, it is suggested to |The value of this field is implementation-dependent. | | +| | | |use URL as identifier | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.identifiers[*] |Array of Objects |recommended |The array of the objects representing external |structure, no need to map | | +| | | |identifiers for the entity | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.identifiers[*].scheme |String |mandatory |The scheme/name of the external identifier |/codeBook/stdyDscr/citation/holdings/ExtLink/@title |Using ExtLink element is a workaround, there is not actually a field | +| | | |system | |for identifier/URL pointing to the organization (data source) | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.identifiers[*].value |String |mandatory |The external identifier |/codeBook/stdyDscr/citation/holdings/ExtLink/@URI | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.entity_type |String |mandatory |Needed for parsing purposes; fixed to datasource |information can be generated because it is always “datasource” | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.name |String |optional |The name of a Data source. |/codeBook/stdyDscr/citation/holdings/@location | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.persistent_identity_system |Array of Objects |optional |The persistent identifier systems that are used |not applicable | | +|s[*] | | |by a Data source to identify the ProductType it | | | +| | | |supports. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.persistent_identity_system |? |mandatory |The Product type to which the persistent |not applicable | | +|s[*].for | | |identifier is referring to. Allowed values: | | | +| | | |literature, research data, software, metadata, | | | +| | | |any | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.persistent_identity_system |Array of Strings |mandatory |Persistent identifier schemes used to refer to |not applicable | | +|s[*].pid_schemes[*] | | |ProductTypes. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.audience[*] |Array of Objects |optional |The property defines the target audiences of the |not applicable | | +| | | |users of a Data source. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.audience[*].audience_type |String |mandatory |The type of the audience based on the vocabulary |not applicable | | +| | | |"Jurisdiction". Allowed values "Global", | | | +| | | |"National", "Regional", "Institution", "Research | | | +| | | |infrastructure", "e-infrastructure" | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.data_source_classification |String |optional |The specific type of a Data source, based on the |not applicable | | +| | | |vocabulary Data source Classification. It can be | | | +| | | |chosen among the following values: repository, | | | +| | | |aggregator, scientific database, journal | | | +| | | |archive, publisher archive, cris system | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.research_product_type[*] |Array of Strings |optional |The types of entities managed by a Data source. |not applicable | | +| | | |Each item in the list should be compliant with | | | +| | | |the following terms: metadata, research data, | | | +| | | |literature, software, any | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.disciplines[*] |Array of Strings |optional |The disciplines for which a Data source is |not applicable | | +| | | |dedicated - specified using the Library of | | | +| | | |Congress Classification codes, available at | | | +| | | |https://id.loc.gov/authorities/classification | | | +| | | |(e.g. PA3000-PA3049 for classical literature). | | | +| | | |In case a Data source is discipline agnostic, | | | +| | | |the string all should be specified. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.policies[*] |Array of Objects |optional |The policies followed by a Data source. |not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.policies.about |String |mandatory |The type of policy to consider. |not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.policies.target[*] |Array of Strings |recommended |The types of resources to which the policy |not applicable | | +| | | |applies to, allowed values: : metadata, research | | | +| | | |data, literature, software, any | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.policies.documented_at |String |recommended |The URL of the document that describes the |not applicable | | +| | | |policy. | | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ +|$.policies.description |String |recommended |Describe the type of policy, if necessary. |not applicable | | ++------------------------------+------------------+----------------------+--------------------------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------+ diff --git a/docs/commons/skg/mappings/Mapping-SKGIF-OpenAIRE.rst b/docs/commons/skg/mappings/Mapping-SKGIF-OpenAIRE.rst new file mode 100644 index 0000000..ca6a48a --- /dev/null +++ b/docs/commons/skg/mappings/Mapping-SKGIF-OpenAIRE.rst @@ -0,0 +1,114 @@ +OpenAIRE SKG-IF Mapping +----------------------------------------- +.. page-authors:: + Miriam Baglioni + + + +This page documents the conceptual mapping between the `OpenAIRE Graph model `_ towards the `SKG-IF `_ (`version 1.1.0 `_). + +The OpenAIRE APIs implementation draws from this mapping. The mapped entities reported are only those returned by the APIs. So far only research products. + +Research Product +=============================================== + +.. list-table:: + :header-rows: 1 + + * - SKG-IF JSON-LD property + - OpenAIRE Graph property + - Notes + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#local_identifier + - https://graph.openaire.eu/docs/data-model/entities/research-product#id + - The internal identifier is used to resolve to the landing page in Explore for the research product. The URL prefix "https://explore.openaire.eu/search/result?id=" is added to the result identifier. + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#identifiers + - https://graph.openaire.eu/docs/data-model/entities/research-product#pids + - + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#entity_type + - product + - Fixed value + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#titles + - https://graph.openaire.eu/docs/data-model/entities/research-product#maintitle or https://graph.openaire.eu/docs/data-model/entities/research-product#subtitle + - Maps the first title with type *main title*. If no *main title* exists, it maps the first *subtitle*. The element always has *none* as language keyword. + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#abstracts + - https://graph.openaire.eu/docs/data-model/entities/research-product#descriptions + - Maps the whole set of descriptions. All of them are associated with the language tag *none*. + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#product_type + - https://graph.openaire.eu/docs/data-model/entities/research-product#sub-types + - The sub-types are mapped in the SKG-IF as: + + - publication → literature + - dataset → research data + - software → research software + - otherresearchproduct → other + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#topics + - https://graph.openaire.eu/docs/data-model/entities/research-product#subjects + - The mapping considers *{FOS, SDG, keyword}* subject schemes. Each subfield is mapped as follows: + + - term → otf identifier depending on the creation date of the dataset, and the value for the topic + - **provenance** + + - trust → subject.provenance.trust + - provenance → subject.provenance.provenance + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#contributions + - https://graph.openaire.eu/docs/data-model/entities/research-product#authors + - Each subfield is mapped as follows: + + - by → otf identifier depending on the creation date of the dataset and the ORCID if found in the metadata. If no ORCID is found, the identifier depends on the creation date and a concatenation of result ID and author position in the list of authors. + - declared_affiliations → not mapped so far + - rank → author[*].rank + - contribution_types → not mapped so far + - role → author + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#manifestations + - https://graph.openaire.eu/docs/data-model/entities/research-product#instances, https://graph.openaire.eu/docs/data-model/entities/research-product#container, and https://graph.openaire.eu/docs/data-model/relationships/relationship-object + - Each subfield is mapped as follows: + + - **type** + + - class → the COAR classification for instance[*].type + - labels → instances[*].type (language keyword always *en*) + - defined_in → https://vocabularies.coar-repositories.org/resource_types/ (Fixed) + + - dates → instance.publicationDate (date type always *publication*) + - identifiers → instances[*].pids + - **peer_review** + + - status → set to *peer reviewed* if instances[*].refereed is *peer reviewed* + - description → not mapped so far + + - **access_right** + + - status → instances[*].accessright.label + - description → fixed text depending on status value + + - licence → instances[*].licence + - version → not mapped + - **biblio** + + - issue → container.iss (only for publications) + - edition → container.edition (only for publications) + - volume → container.volume (only for publications) + - pages → container.sp and container.ep (only for publications) + - in → otf identifier depending on the creation date and container.issnPrinted. If not present, container.issnOnline is used + - hosting_datasource → "https://explore.openaire.eu/search/dataprovider?datasourceId=" + target in the relation isHostedBy + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#relevant_organisations + - https://graph.openaire.eu/docs/data-model/relationships/relationship-object + - The list of landing pages in OpenAIRE built from organization identifiers found in *relation.source* for relations with *relation.relType.name = isAuthorInstitutionOf* and *relation.target* as the considered result + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#funding + - https://graph.openaire.eu/docs/data-model/relationships/relationship-object + - The list of landing pages in OpenAIRE built from project identifiers found in *relation.source* for relations with *relation.relType.name = produces* and *relation.target* as the considered result + + * - https://skg-if.github.io/interoperability-framework/docs/research-product.html#related_products + - https://graph.openaire.eu/docs/data-model/relationships/relationship-object + - For each supported semantics in SKG-IF, the corresponding semantics in the OpenAIRE graph is considered. For any relation type, the list of landing pages in OpenAIRE is built from *relation.target* relations having as *relation.source* the result under consideration diff --git a/docs/commons/skg/mappings/Mapping-SKGIF-RO-Crate.rst b/docs/commons/skg/mappings/Mapping-SKGIF-RO-Crate.rst new file mode 100644 index 0000000..b345399 --- /dev/null +++ b/docs/commons/skg/mappings/Mapping-SKGIF-RO-Crate.rst @@ -0,0 +1,188 @@ +Mapping between SKG Interoperability Framework and RO-Crate +-------------------------------------------------------------- +.. page-authors:: + Raul Palma + + +**RO-crate** (https://w3id.org/ro/crate/1.2) is an open, community data package specification for describing all kinds of research data and related resources, within and outside the package, used and generated throughout the research process in alignment with the FAIR principles. +RO-Crates are rich structured metadata containers, providing a straightforward and lightweight implementation of FDOs, which are part of the long-term vision of EOSC. +The metadata, expressed in JSON-LD following the Linked Data approach, describes the package and the aggregated research data entities like datasets, software, workflows, publications, as well as the associated contextual entities such as people, organizations, software and equipment, in a series of linked JSON-LD objects - using common published vocabularies, chiefly schema.org.  + +**The mapping between SKG-IF and RO-Crate** is intended for individuals who are familiar with RO-Crate specification, but new to SKG-IF. +The mapping is presented in the table below. + + ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Unnamed: 0 | RO-Crate Term | SKG-IF Ontology Term | SKG-IF JSON-LD term | Type | Fixed values | ++===========================+========================================+==================================+=====================================+==========+==============================================+ +| ResearchObject (RO-Crate) | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | dcterms:title | titles | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Dataset | fabio:Work | entity_type=product | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Dataset | fabio:Dataset | product_type=research data | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | ro:ResearchObject | | product_type=rocrate_ResearchObject | Class | extension | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier (supposed to be @id) | | local_identifier | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | w3id (extension) | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | literal:hasLiteralValue | value | Property | ro-id/xxxx | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:author | pro:isRelatedToRoleInTime | contributions | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:contributor | pro:isRelatedToRoleInTime | contributions | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:publisher | pro:isRelatedToRoleInTime | contributions | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | author/contributor/publisher @id | pro:isHeldBy | by | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | pro:withRole | role | Property | author/contributor = author, publisher = | +| | | | | | publisher, creator = editor, | +| | | | | | copyrightHolder= rocrate_copyright-owner | +| | | | | | (extension) | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | co:index | rank | Property | Auto-incremental | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:description | dcterms:abstract | abstract | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:hasPart | schema:hasPart | rocrate_hasPart | Property | extension | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:funding | frapo:isFundedBy | funding | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:studySubject | bido:holdsBibliometricDataInTime | topics | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:sdDatePublished | dcterms:issued | publication | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:dateCreated | dcterms:created | creation | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:dateModified | dcterms:modified | modified | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Grant | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | @id | | local_identifier | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Grant | frapo:Grant | entity_type=grant | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:funder | frapo:hasFundingAgency | funding_agency | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | foaf:name | name | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:title | dcterms:title | titles | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | doi | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | http://purl.org/ontology/bibo/doi | literal:hasLiteralValue | value | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| FundingAgency | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | @id | | local_identifier | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Organization | frapo:FundingAgency | entity_type=funder | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | foaf:name | name | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | doi | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | http://purl.org/ontology/bibo/doi | literal:hasLiteralValue | value | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Authors/contributors | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | @id | | local_identifier | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Person | foaf:Person | entity_type=person | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | foaf:name | name | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:givenName | foaf:givenName | given_name | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:familyName | foaf:familyName | family_name | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | orcid/email (extension) | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | https://w3id.org/dingo#orcid or | literal:hasLiteralValue | value | Property | | +| | schema:email | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Publisher/copyrightholder | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | @id | | local_identifier | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Organization | foaf:Organization | entity_type=organisation | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | foaf:name | name | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | ror/email (extension) | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier or schema:email | literal:hasLiteralValue | value | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Topic | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | @id | | local_identifier | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:DefinedTerm | fabio:SubjectTerm | entity_type=topic | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | skos:prefLabel | labels | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | url | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | literal:hasLiteralValue | value | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Data source | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | @id | | local_identifier | Property | local_identifier=https://doi.org/10.25504/FA | +| | | | | | IRsharing.d3c5fd | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:DataCatalog | dcat:DataService | entity_type=datasource | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:name | foaf:name | name | Property | name=ROHub | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:identifier | datacite:hasIdentifier | identifiers | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | datacite:usesIdentifierScheme | scheme | Property | doi | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | literal:hasLiteralValue | value | Property | value=10.25504/FAIRsharing.d3c5fd | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | odrl:hasPolicy | policy | Property | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | | odrl:action | about | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:target | odrl:target | target | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:mainEntityOfPage | foaf:page | documented_at | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:conformsTo | dcerms:conformsTo | persistent_identity_systems | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:requirements | dcterms:requires | pid_schemes | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:target | dcterms:coverage | for | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema: hasDefinedTerm | dcat:theme | data_source_classification | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:target | dcterms:coverage | research_product_type | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| Other | | | | | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:CreativeWork | skg:ResearchProduct | entity_type=product | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:ScholarlyArticle | fabio:ScholarlyWork | entity_type=literature | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:SoftwareSourceCode | fabio:Software | entity_type=research software | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:Event | fabio:ExpressionCollection | entity_type=venue | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ +| | schema:PublicationEvent | fabio:ExpressionCollection | entity_type=venue | Class | | ++---------------------------+----------------------------------------+----------------------------------+-------------------------------------+----------+----------------------------------------------+ diff --git a/docs/commons/skg/mappings/index.rst b/docs/commons/skg/mappings/index.rst new file mode 100644 index 0000000..7fe3ee2 --- /dev/null +++ b/docs/commons/skg/mappings/index.rst @@ -0,0 +1,49 @@ +SKG-IF mappings +================ + +Overview +--------- + +SKG mappings are structured specifications that translate existing scholarly metadata schemas, exchange formats, or APIs into formats compliant with the SKG Interoperability Framework (SKG-IF) Core Data Model and SKG-IF Extensions. These mappings are published as part of the SKG Commons to foster interoperability and automation across Scholarly Knowledge Graph (SKG) providers. + +Purpose +------- +The main goals of SKG mappings are: + +- Enable machine-actionability: Transform heterogeneous, often bespoke SKG or metadata representations into structured, interoperable formats that can be consistently processed by software systems in accordance with SKG-IF. +- Support integration with SKG-related services: Facilitate connections between SKG providers and services, including CRIS/RIS systems, repositories, PID infrastructures, and other scholarly information systems. +- Provide a shared reference: Publish mappings as part of the Commons so they can be reused, profiled, and adapted by other projects, domains, and communities. + +Creation Process +------------------ + +The development of SKG mappings follows a collaborative workflow: + +1. Select a source schema, format, or interface: Identify the metadata schema, exchange format, API, or SKG model that should be aligned with SKG-IF. +2. Review SKG-IF and existing extension profiles: Familiarise yourself with the SKG-IF Core Data Model and relevant SKG-IF Extensions or application profiles. Review existing mappings where available. +3. Draft the mapping: + - Map entities, relationships, and fields from the source specification to SKG-IF components. + - Define validation rules, cardinalities, and controlled vocabularies (e.g., identifiers, resource types, access categories). + - Propose additions or revisions to SKG-IF Extensions where no suitable target element exists. +4. Test usability: Validate the mapping using representative real-world datasets or graph instances to ensure that it is practical, loss-minimising, and supports intended interoperability scenarios. +5. Publish as Commons: The validated mapping is contributed to the SKG Commons and made available for reuse and further refinement. + +Integration +----------- + +Once established, SKG mappings can be implemented by SKG platforms and related services to achieve interoperability. These integrations enable automated data exchange and graph enrichment, ensuring that SKGs remain consistent, up-to-date, and interoperable across the research ecosystem. The concrete implementation work lies with the respective tool and service owners; SKG mappings provide the technical guidance they need to achieve interoperability. + +Mappings +-------- + +Below, we list SKG mappings defined for commonly used scholarly metadata sources: + + +.. toctree:: + :maxdepth: 1 + :titlesonly: + + DDI SKG-IF mapping + RO-Crate SKG-IF mapping + OpenAIRE Graph SKG-IF mapping + diff --git a/docs/commons/skg/skg-commons.rst b/docs/commons/skg/skg-commons.rst new file mode 100644 index 0000000..66a7cd3 --- /dev/null +++ b/docs/commons/skg/skg-commons.rst @@ -0,0 +1,51 @@ +SKG Commons +============ + +.. page-authors:: + Andrea Mannocci + Paolo Manghi + Renaud Duyme + Menzo Windhower + Daan Broader + + +The SKG Commons provide a common, reusable, +extensible, and interoperable foundation for handling data exchange between Scholarly Knowledge Graph (SKG) +interfaces across tools and services that implement the Scholarly Knowledge Graph Interoperability Framework (SKG-IF). +They specify how SKG information is modelled, constrained, and exchanged, +while remaining neutral regarding the internal design or implementation of individual systems. The main audience for the SKG Commons consists of software developers who build services to create, manage, or consume SKGs. This includes SKG providers (e.g., OpenAIRE Graph, OpenCitations), other services that manage scholarly metadata and wish to expose interoperable interfaces (e.g., FAIRSharing, RO-Hub), and services that want to integrate with such platforms, as described in the OSTrails Architecture and Pathways. + +The Commons are organised as a framework composed of a shared core data model, SKG-IF community extensions to that model, +standard APIs, and shared mappings from local platform models onto the SKG-IF: + +- **RDA SKG-IF Core Data Model**: The base model that captures the key SKG entities, relationships, and constraints in a machine-actionable form. +- **SKG-IF Extensions**: Community- or domain-specific specialisations of the core model that add entities, fields, and constraints to meet particular interoperability and policy requirements. +- **SKG Commons API Specifications**: Standardised APIs for programmatic access to SKG data across platforms, built on the core model and designed to work with the defined application profiles. +- **SKG mappings**: data model mappings between SKG-IF and external vocabularies, schemas, and domain models, facilitating the creation of application profiles and the alignment of SKG information with existing standards. + +These layers together ensure a consistent understanding of SKG content and predictable behaviour when services interact, regardless of how they are implemented internally. This design enables platforms to evolve independently while remaining interoperable at their interfaces. + + +The SKG Commons primarily target software developers, system architects, and service providers who build or run SKGs and related research information services. Researchers and other end users typically do not interact with the Commons directly; instead, they benefit indirectly through improved automation, more comprehensive linking of research outputs and actors, and enhanced reuse of SKG data across systems. +The SKG Commons follow a community-driven, evolutionary approach, meaning they are intended to adapt continuously to community input, emerging practices, and new interoperability demands. They are grounded in work carried out within the Research Data Alliance (RDA), notably the SKG Interoperability Framework and associated recommendations, and they actively feed back into these communities. The framework supports stepwise adoption while still enabling full interoperability once all components are in place. + +Contribution and future evolution +---------------------------------- +The SKG Commons actively collaborate with and contributes to the further development of the SKG-IF Core Data Model and SKG-O. + +This contribution is informed by practical implementation experience with SKG-IF Extensions, JSON-LD contexts, SHACL validation, and the SKG Commons APIs, as well as by identifying gaps or ambiguities that hinder interoperability across infrastructures, domains, or regions. + +Proposed enhancements are not limited to a particular platform or geography; they aim to strengthen SKG-IF for the broader international community and future versions of the framework. As SKG-IF evolves, the SKG Commons will track and adopt new versions, preserving continuity while enabling incremental uptake of improvements. + + +The following resources in this section are part of the SKG Commons component. + +.. toctree:: + :caption: SKGs Resources + :maxdepth: 1 + :titlesonly: + + OSTrails Metadata Model for SKGs + OSTrails SKG-IF API Specification + OSTrails SKG-IF Extensions + SKG-IF mappings diff --git a/docs/commons/skg/skg-if-api-specification.rst b/docs/commons/skg/skg-if-api-specification.rst new file mode 100644 index 0000000..b70e828 --- /dev/null +++ b/docs/commons/skg/skg-if-api-specification.rst @@ -0,0 +1,81 @@ +OSTrails SKG-IF API Specification +================================== + +The SKG-IF OpenAPI specification defines a common way to programmatically interact with Scholarly Knowledge Graph (SKG) providers and related services. The API enables uniform access to SKG information and operations, even when individual implementations differ in their internal architectures, technology stacks, or integration patterns. + +Purpose and design principles +------------------------------- + +The SKG-IF API specifications are designed so as to: + +* Provide a standardised REST/OpenAPI interface for SKG-IF entities (research products, agents, venues, data sources, grants, topics); +* Support machine-to-machine interoperability in heterogeneous environments; +* Decouple external interactions from internal data models and storage technologies; +* Facilitate validation, testing, and automation of SKG-IF–based workflows. + + +The specification focuses on the shape and semantics of the JSON responses and operations, not on how services internally manage or persist data. This enables the independent evolution of local systems while maintaining a predictable, interoperable way for exchanging data. + +Relationship to the data model and JSON-LD +--------------------------------------------- + +The SKG-IF OpenAPI builds directly on the SKG-IF Data Model and the SKG-IF JSON-LD context. In particular: + +* Single-entity operations (`/{entity-type}/{local_identifier}`) return JSON that is compatible with the SKG-IF JSON-LD context (via `@context`), and **must** conform to the OpenAPI response schemas. +* Search operations (`/{entity-type}?filter=…`) return JSON-only responses with a `meta` object and a `results` array; work is in progress to provide an appropriate JSON-LD context pattern for paged/search results. + +The specification defines how key SKG-IF concepts, such as `local_identifier`, `entity_type`, and identifiers (DOI, ORCID, ROR, etc.), as well as embedded entities (e.g., agents and venues within products), are exposed via the API. + +Uniform operations and validation across implementations +--------------------------------------------------------- + +By implementing the SKG-IF OpenAPI, SKG-IF providers can expose a consistent set of operations, such as: + +* Retrieving a single entity by `local_identifier`, +* Searching entities using filter expressions, +* Serving JSON-LD–compatible representations for core SKG-IF entities. + +Implementations can be automatically validated against the SKG-IF OpenAPI specification using a validation proxy such as Stoplight Prism. A typical validation setup: + +1. Download the SKG-IF OpenAPI YAML file: https://skg-if.github.io/api/openapi/ver/current/skg-if-openapi.yaml +2. Run a Prism proxy in front of your implementation, e.g.: docker run --init --rm -v $(pwd):/tmp -p 4010:4010 stoplight/prism:4 proxy -h 0.0.0.0 /tmp/skg-if-openapi.yaml http://my-dev-server:8080 --errors +3. Exercise your endpoints through the proxy (e.g., http://localhost:4010/products) and use the proxy responses to detect schema and contract violations. + +This validation approach can be integrated into CI/CD pipelines. If an implementation passes the OpenAPI conformance tests, it is considered compliant with SKG-IF at the API level; SHACL validation is not required in addition to OpenAPI compliance. + +Community governance and maintenance +------------------------------------- + +The SKG-IF OpenAPI specification is developed and maintained collaboratively within the RDA SKG-IF Working Group and its broader implementer community. Discussion and feedback loops are driven by concrete implementation experience (e.g., hackathons, pilot deployments) and captured in public issue trackers and documents. + +Relevant community resources include: + + * SKG-IF OpenAPI YAML (“current” dev version): https://skg-if.github.io/api/openapi/ver/current/skg-if-openapi.yaml + * GitHub source (current): https://raw.githubusercontent.com/skg-if/api/refs/heads/main/openapi/ver/current/skg-if-openapi.yaml + * Permanent alias for the current version: https://w3id.org/skg-if/api/skg-if-openapi.yaml + * General API repository: https://github.com/skg-if/api + * RDA SKG-IF WG and implementer channel on Discord. + +These venues are the authoritative places to report issues, discuss design choices (e.g., filter grammar, JSON-LD options, authentication strategies), and propose enhancements. + +Documentation and versioning +----------------------------- + +The SKG-IF OpenAPI specification is published as a machine-readable OpenAPI document and can be explored through multiple viewers: + + * Stoplight Elements: https://elements-demo.stoplight.io/?spec=https://skg-if.github.io/api/openapi/ver/current/skg-if-openapi.yaml + * Redocly Redoc: https://redocly.github.io/redoc/?url=https://skg-if.github.io/api/openapi/ver/current/skg-if-openapi.yaml + * Swagger Editor https://editor-next.swagger.io with input https://skg-if.github.io/api/openapi/ver/current/skg-if-openapi.yaml + +Versioning follows a clear separation between the SKG-IF Data Model / JSON-LD context version (e.g., `https://w3id.org/skg-if/context/1.0.1/skg-if.json`), and the **SKG-IF OpenAPI** version, using semantic versioning in `info.version` (e.g., `1.1.3`), with the rule that major versions of the data model and the OpenAPI should always match. + +Examples: +--------- + + * Official released OpenAPI version: https://github.com/skg-if/api/openapi/ver/1.1.3/skg-if-openapi.yaml + * Permanent URL: https://w3id.org/skg-if/api/1.1.3/skg-if-openapi.yaml + * Data Model / context versions: https://w3id.org/skg-if/context/1.0.0/skg-if.json, and https://w3id.org/skg-if/context/1.0.1/skg-if.json + * Current alias: https://w3id.org/skg-if/context/skg-if.json + +The specification evolves iteratively, incorporating feedback from real-world implementations (e.g., on filters, extensions, missing fields, JSON-LD behaviour). Future versions aim to maintain compatibility with the SKG-IF Data Model while providing a stable yet extensible API surface for the SKG Commons. + diff --git a/docs/commons/skg/skg-if-entity-extension.rst b/docs/commons/skg/skg-if-entity-extension.rst new file mode 100644 index 0000000..003c3d6 --- /dev/null +++ b/docs/commons/skg/skg-if-entity-extension.rst @@ -0,0 +1,41 @@ +OSTrails SKG-IF Extensions +============================ + +SKG-IF extensions are introduced as a strategic mechanism to address the evolving and diverse needs of scientific communities and projects. Within the SKG-IF, extensions are intended to capture shared requirements and interests that are not fully covered by the core set of entities and properties. + + +By enabling the definition of extensions that enrich the core SKG-IF model, the framework can support specialised use cases, discipline- or project-specific requirements, and emerging data practices, while preserving the integrity and structure of the underlying model. + +Extensions provide a controlled way to expand the framework’s capabilities without altering existing entities, thereby maintaining compatibility, conceptual coherence, and interoperability across different datasets and scholarly knowledge graphs. + + +The status of such extension proposed is summarised in the table below: + +.. list-table:: Extensions + :header-rows: 1 + :widths: 10 30 30 30 + + * - Acronym + - Scope + - Status + - Link/request + * - RA-SKG + - Indicators for products and agents + - Development finalised + - https://skg-if.github.io/ext-ra-skg/ + * - SRV + - New entity to model services + - Under development + - https://skg-if.github.io/ext-srv + * - GEO-SKG + - Geolocation and timestamps for products + - Accepted + - https://skg-if.github.io/ext-geo-skg/ + * - SKG-PROV + - Provenance tracking + - To be discussed + - https://github.com/skg-if/extensions/issues/4 + * - RP-STDS + - Research Products for Standards + - To be discussed + - https://github.com/skg-if/extensions/issues/5 diff --git a/docs/commons/skg/skg-if-metadata-model.rst b/docs/commons/skg/skg-if-metadata-model.rst new file mode 100644 index 0000000..55cbcf1 --- /dev/null +++ b/docs/commons/skg/skg-if-metadata-model.rst @@ -0,0 +1,56 @@ +OSTrails Metadata Model for SKGs +================================== + +The RDA Scholarly Knowledge Graph Interoperability Framework (SKG-IF) Core Data Model defines a minimal, interoperable metadata model for representing SKG data in a machine-actionable way. + +The model is used to describe the main SKG-IF entities, their attributes, and their relations, using Semantic Web technologies. It reuses and aligns existing ontologies that address specific scholarly communication scenarios, ensuring compatibility with the overall aims of SKG-IF while avoiding reinvention of established models. + +The SKG-IF Core Data Model, summarised in Graffoo diagrams, supports the representation of the following key entities: + +- **Agent**: individuals or organisations (or other acting entities) involved in the creation, publication, dissemination, curation, or assessment of research products. +- **Data source**: services or platforms where research products (metadata and, where applicable, files) are stored, preserved, made discoverable, and accessed. +- **Grant**: funding awarded by a funding body to one or more agents. +- **Research product**: research outputs of different types, such as research literature, research data, research software, or other categories. +- **Topic**: scientific disciplines, subjects, or keywords relevant to a research product and its context. +- **Venue**: publishing or dissemination channels through which research products are made available (e.g., journals, conferences, platforms). + +The SKG-IF Core Data Model is implemented as an OWL ontology, the SKG-IF Ontology (SKG-O). Rather than introducing yet another standalone bibliographic ontology, SKG-O aggregates and organises complementary ontological entities from several existing vocabularies used within SKG-IF, providing a coherent space for descriptive metadata compliant with the SKG-IF Data Model. + +SKG-O is structured into six ontological modules, one for each SKG-IF entity type, all formally imported into the main ontology: + + - **SKG-O**: agent – https://w3id.org/skg-if/ontology/agent/ + - **SKG-O**: data-source – https://w3id.org/skg-if/ontology/data-source/ + - **SKG-O**: grant – https://w3id.org/skg-if/ontology/grant/ + - **SKG-O**: research-product – https://w3id.org/skg-if/ontology/research-product/ + - **SKG-O**: topic – https://w3id.org/skg-if/ontology/topic/ + - **SKG-O**: venue – https://w3id.org/skg-if/ontology/venue/ + +Version and usage +------------------ +Within the SKG Commons, the SKG-IF Core Data Model and SKG-O serve as the foundational layer on which higher-level specifications are built: SKG-IF Extensions, application profiles, and the SKG Commons API specifications. All additional constraints and specialisations are defined on top of this core model, ensuring alignment with the RDA SKG-IF framework. + +SKG-IF data produced under the Interoperability Framework align with SKG-O via the SKG-IF JSON-LD context, which binds JSON structures to ontology terms. Furthermore, a dedicated SHACL shapes document is provided for semantic validation of data against the Core Data Model, ensuring conformance and consistency across implementations. + +Scope and role within the SKG Commons +---------------------------------------- + +Within the SKG Commons, the SKG-IF Core Data Model: + +- Defines the minimum set of concepts required to describe SKGs in a machine-actionable, semantically rich way +- Establishes a shared semantic baseline across tools and services +- Enables interoperability without dictating internal data models or architectures in individual systems + +Domain- or policy-specific requirements are intentionally handled at higher layers (e.g., SKG-IF Extensions and application profiles). This separation keeps the core model stable, reusable, and broadly applicable across communities and infrastructures. + +Community governance and maintenance +--------------------------------------- +The SKG-IF Core Data Model and SKG-O are developed and maintained by the community within the Research Data Alliance (RDA) SKG-IF activities. Issues, discussions, and change proposals concerning the model and ontology are managed via the established RDA community processes. + +Typical resources include: + + * `SKG-IF Framework: `_ + * `SKG-IF on GitHub: `_ + * `JSON-LD Context: `_ + +These venues are the authoritative channels for proposing changes, reporting issues, and discussing the ongoing evolution of the SKG-IF Core Data Model and its ontology. + diff --git a/docs/conf.py b/docs/conf.py index 22b6083..e6fa529 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,6 +14,7 @@ project = 'OSTrails' release = '0.1.0' +master_doc = 'index' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/docs/index.rst b/docs/index.rst index e5e6e4e..2cf7368 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,7 @@ Documentation Structure The documentation is structured as follows: .. toctree:: - :maxdepth: 2 + :maxdepth: 4 :caption: Architecture Introduction @@ -23,16 +23,23 @@ The documentation is structured as follows: .. toctree:: - :maxdepth: 2 + :maxdepth: 4 :caption: Commons Introduction Governance Resources +.. toctree:: + :maxdepth: 4 + :caption: Tools + + FAIR Tools + DMP Tools + SKG Tools .. toctree:: - :maxdepth: 2 + :maxdepth: 4 :caption: Other other/vocabulary diff --git a/docs/references.bib b/docs/references.bib index 05db23b..1c836f0 100644 --- a/docs/references.bib +++ b/docs/references.bib @@ -55,3 +55,9 @@ @misc{ostrails_d2.5 doi = {10.5281/zenodo.14795060}, } +@misc{Miksa_RDA_DMP_Common, + author = {Miksa, Tomasz and Walk, Paul and Neish, Peter}, + doi = {10.15497/rda00039}, + title = {{RDA DMP Common Standard for Machine-actionable Data Management Plans}}, + version = {1.1} +} diff --git a/docs/tools/DMP.rst b/docs/tools/DMP.rst new file mode 100644 index 0000000..767eda1 --- /dev/null +++ b/docs/tools/DMP.rst @@ -0,0 +1,4 @@ +OSTrails DMP Tools +=================== + +The following resources in this section are part of the DMP Tools. diff --git a/docs/tools/FAIR.rst b/docs/tools/FAIR.rst new file mode 100644 index 0000000..996ef12 --- /dev/null +++ b/docs/tools/FAIR.rst @@ -0,0 +1,20 @@ +OSTrails FAIR Tools +==================== + + +The following resources in this section are part of the FAIR Tools component. + +.. toctree:: + :caption: Tools + :maxdepth: 1 + :titlesonly: + + FAIR Champion + FOOPS + FAIROS + FAIRsharing + FAIR Assessment Authoring Tool + FAIR Validator + Catalogue of Benchmark Scoring Algorithms + Catalogue of Benchmarks and Metrics + Catalogue of Tests diff --git a/docs/tools/FAIR_tools/Catalogue-of-Benchmark-Scoring-Algorithms.rst b/docs/tools/FAIR_tools/Catalogue-of-Benchmark-Scoring-Algorithms.rst new file mode 100644 index 0000000..470c005 --- /dev/null +++ b/docs/tools/FAIR_tools/Catalogue-of-Benchmark-Scoring-Algorithms.rst @@ -0,0 +1,60 @@ +Catalogue-of-Benchmark-Scoring-Algorithms +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +FAIR Data Point +---------------- + +OSTrails has generated a federated metadata registry for publishing and +indexing FAIR Scoring Algorithm descriptions. Every Algorithm intended to be discoverable +and to support FAIR assessment activities should be registered in this +repository. + +This repository is built on top of the **FAIR Data Point (FDP)**, a +software framework maintained by the +`FAIRDataTeam `_. + +The FDP index includes descriptions of test records from multiple +assessment tools, such as +`FAIR Champion `_ +and +`FOOPS `_. + +Registering a Scoring Algorithm in the Catalogue +-------------------------------------------------- + +To register a Scoring Algorithm, you may use one of the following standardised +procedures: + +Submitting an Existing Metadata Record via FAIR Champion +------------------------------------------------------------ + +Visit the FAIR Champion registration page: https://tests.ostrails.eu/tests/new + +Provide the persistent unique identifier of your existing metadata +record and submit it for indexing. + +You may verify the publication and validation status of your metadata at: https://tools.ostrails.eu/fdp-index/ + +If your DCAT record contains structural or semantic errors, the metadata +may be displayed as **invalid**. + + + NOTE: This method requires the metadata record to already exist in your + tool or repository. The record **must** comply with the FTR model. + +Registering Metadata via the FAIR Assessment Authoring Tool +-------------------------------------------------------------- + +The FAIR Assessment Authoring Tool, developed by the OSTrails team, +supports the creation of FAIR assessment components such as Tests, +Metrics, Benchmarks, and others. + +Through a machine-actionable questionnaire, the tool automatically +generates the metadata record, stores it, and submits it to an OSTrails +GitHub repository that acts as an openly accessible, self-hosted +index for transparency and long-term availability. This submission also +registers the record in the FDP-based OSTrails index: https://tools.ostrails.eu/fdp-index/ + +The FAIR Assessment Authoring Tool is available at: https://ostrails-fair.fair-wizard.com/wizard/dashboard + +All its documentation is available `here `_ diff --git a/docs/tools/FAIR_tools/Catalogue-of-Benchmarks.rst b/docs/tools/FAIR_tools/Catalogue-of-Benchmarks.rst new file mode 100644 index 0000000..91a0455 --- /dev/null +++ b/docs/tools/FAIR_tools/Catalogue-of-Benchmarks.rst @@ -0,0 +1,49 @@ +Catalogue of Metrics and Benchmarks +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The FAIRassist registry (`https://fairassist.org/registry `_), powered by FAIRsharing +(`https://fairsharing.org/ `_), is the catalogue of metrics and benchmarks for OSTrails and the +wider community making use of the Assess-IF. + +FAIRassist (for conceptual components) and the FDP Index (for software components) are complementary exemplar services +that showcase: + +- Registration and sharing of the components of the Assess-IF, +- Assistance with their discoverability (based on digital object types, discipline specificity, or generic scope), and +- Information and documentation to guide and assist during the FAIR assessment process. + +Registration with FAIRassist and FDP is strongly recommended for transparency and for FAIRness. DOIs will be minted for +metrics and benchmarks once the maintainer of the resource considers it ready and no longer in development. + +For more information, please see the sections on FAIRsharing and FAIRassist +(:ref:`fairsharing-registry`, :ref:`fairassist-registry`). + +Via content negotiation and various FAIRsharing APIs, this registry makes a rich set of human-curated data available to +FAIR assessments in a machine-actionable format using DCAT and JSON. + +Searching and Filtering Metrics and Benchmarks +---------------------------------------------- + +Metrics and benchmarks can be filtered and searched via +`https://fairassist.org/registry `_ in two ways: + +1. Through graphical navigation beginning with the FAIR Principles of interest to the user and traversing to, ultimately, any benchmarks linked to those principles (Figure 1). + +2. By selecting as many filters and/or search strings as required. The search results generated are separated into sections according to record type and include not only the metrics and/or benchmarks of interest, but also related standards, databases, policies, and collections from the broader FAIRsharing registry (Figures 2 and 3). + +Guided Discovery and Re-use +--------------------------- + +FAIRassist guides users to the benchmarks and metrics they need through a variety of routes, including: + +- The FAIR principles to which they relate. +- Subject area and research object type of interest. +- Associated organisations. +- The FAIR evaluation tools that implement them. + +The ecosystem of related resources is summarised and presented as tabular results, enabling further exploration and +ultimately fostering component re-use. + +If a user finds a metric that suits their needs, they can re-use that metric very easily, particularly when filtering +by tools that already implement it. Future work will add additional filters as well as a graphical summary of the +connectivity among the search results. diff --git a/docs/tools/FAIR_tools/Catalogue-of-Tests.rst b/docs/tools/FAIR_tools/Catalogue-of-Tests.rst new file mode 100644 index 0000000..a00bddf --- /dev/null +++ b/docs/tools/FAIR_tools/Catalogue-of-Tests.rst @@ -0,0 +1,60 @@ +Catalogue of Tests +================== + +FAIR Data Point +--------------- + +OSTrails has generated a federated metadata registry for publishing and +indexing FAIR Test descriptions. Every test intended to be discoverable +and to support FAIR assessment activities should be registered in this +repository. + +This repository is built on top of the **FAIR Data Point (FDP)**, a +software framework maintained by the +`FAIRDataTeam `_. + +The FDP index includes descriptions of test records from multiple +assessment tools, such as +`FAIR Champion `_ +and +`FOOPS `_. + +Registering a Test in the Catalogue +----------------------------------- + +To register a test, you may use one of the following standardised +procedures: + +Submitting an Existing Metadata Record via FAIR Champion +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Visit the FAIR Champion registration page: https://tests.ostrails.eu/tests/new + +Provide the persistent unique identifier of your existing metadata +record and submit it for indexing. + +You may verify the publication and validation status of your metadata at: https://tools.ostrails.eu/fdp-index/ + +If your DCAT record contains structural or semantic errors, the metadata +may be displayed as **invalid**. + + + NOTE: This method requires the metadata record to already exist in your + tool or repository. The record **must** comply with the FTR model. + +Registering Metadata via the FAIR Assessment Authoring Tool +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The FAIR Assessment Authoring Tool, developed by the OSTrails team, +supports the creation of FAIR assessment components such as Tests, +Metrics, Benchmarks, and others. + +Through a machine-actionable questionnaire, the tool automatically +generates the metadata record, stores it, and submits it to an OSTrails +GitHub repository that acts as an openly accessible, self-hosted +index for transparency and long-term availability. This submission also +registers the record in the FDP-based OSTrails index: https://tools.ostrails.eu/fdp-index/ + +The FAIR Assessment Authoring Tool is available at: https://ostrails-fair.fair-wizard.com/wizard/dashboard + +All its documentation is available `here `_ diff --git a/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst b/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst new file mode 100644 index 0000000..aaec303 --- /dev/null +++ b/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst @@ -0,0 +1,109 @@ +FAIR Assessment Authoring Tool +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +A complete framework for **generating, registering, and authoring your FAIR assessment components** across different metadata repositories. + +The different FAIR assessment metadata components: + +* FAIR Benchmark +* FAIR Metric +* FAIR Test +* FAIR Benchmark Algorithm + +Authoring workflow +------------------ + +The FAIR Assessment Authoring Tool integrates **three main steps**: + +1. **FAIR Wizard Knowledge Model** + + A questionnaire-based knowledge model for capturing your metadata fields using machine-actionable questions. + It connects via APIs to various registries, such as `ORCID `_, `ROR `_, and `FAIRsharing `_. + +2. **DSW-TDK-based Template Transformation** + + DSW-TDK templates transform your questionnaire data into different serializations, such as JSON and RDF (Turtle). + +3. **Proxy Submission Service** + + Registers your generated metadata into the appropriate repository or registry, authoring your FAIR metadata automatically. + +Submissions +~~~~~~~~~~~ + +The following table summarises the available submission options: + ++-----------------------+----------------+----------------------------+----------------------------------------------+ +| **Registries** | **Format** | **Submission Method** | **Assessment Components** | ++=======================+================+============================+==============================================+ +| FAIRsharing Record | JSON | FAIRsharing Registry | Benchmarks and Metrics | ++-----------------------+----------------+----------------------------+----------------------------------------------+ +| DCAT Record | RDF (Turtle) | GitHub / FAIR Data Point | Benchmarks, Metrics, Tests, Scoring | +| | | | Algorithms | ++-----------------------+----------------+----------------------------+----------------------------------------------+ +| FDP Test Record | RDF (Turtle) | GitHub / FAIR Data Point | Tests | ++-----------------------+----------------+----------------------------+----------------------------------------------+ + + +Step-by-Step Guide +------------------ + +1. Fill in the Questionnaire +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Go to the dedicated environment for this questionnaire: + https://ostrails-fair.fair-wizard.com/wizard/ +2. Register yourself or log in if you already have access. +3. Navigate to **Projects** and click **Create** to start a new project. + Each project corresponds to one FAIR assessment component. +4. Give your project a **name** and select the **filter** corresponding to the specific type of assessment component you want to create. + +2. Template Your Information +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +1. Populate your metadata using the **machine-actionable questionnaire**. +2. Once all desired fields are completed, click **Documents** in the top menu. +3. Create an instance of your completed questionnaire by selecting the latest version of the **FAIR Assessment Authoring Tool Template**. +4. Choose your preferred **serialization format**: + + * **JSON** – for registration in FAIRsharing + * **Turtle (RDF)** – for generating a DCAT-compliant record + +3. Submit Your Information +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Once your document is generated, you can review it or submit it directly using the tool’s **submission service**. + +1. In the **Documents** section, click the three dots icon (⋯) beside your document. +2. Select **Submit**. + +Depending on your document format: + +* If your record is formatted in **JSON**, the submission will be sent via the FAIRsharing API to be authored at their registry. + + .. note:: + + *Why Use This Tool?* + FAIR assessment components are a specific subtype of records within the FAIRsharing registry. + Using this tool significantly reduces manual curation and accelerates the registration process. + +* If your record is formatted in **Turtle**, the submission will be sent via the GitHub API to be registered in an OSTrails GitHub repository for collecting metadata about these assessment components. + +If your assessment component is a **FAIR Test**, this submission will also register the test in the +`OSTrails FAIR Data Point test index `_. + +References +---------- + + * `DCAT Vocabulary (W3C) `_ + * `FAIR Testing Resource (FTR) `_ + * `DSW-TDK Github template repository `_ + * `Proxy service Github repository `_ + * `Proxy service endpoint `_ + * `FAIRsharing API documentation `_ + +Contact us +---------- + +Any question or issue related to this workflow, please contact: +``pablo.alarcon@upm.es`` diff --git a/docs/tools/FAIR_tools/FAIR-Champion.rst b/docs/tools/FAIR_tools/FAIR-Champion.rst new file mode 100644 index 0000000..5da4529 --- /dev/null +++ b/docs/tools/FAIR_tools/FAIR-Champion.rst @@ -0,0 +1,10 @@ +FAIR Champion +^^^^^^^^^^^^^ + +FAIR Champion is a general-purpose FAIR assessment tool intended to be used by all communities and for all digital objects. In this release, FAIR Champion is aware of the 22 FAIR Tests (below), but any test, from any provider, can be registered so long as the test generates a metadata descriptor compliant with the FAIR Reference Model defined by OSTrails. The OpenAPI interface descriptor for this release is only partially complete; the Champion has a variety of functions related to new test registration and benchmark registration that are currently pending decisions by the OSTrails project. + + - **Persistent identifier**: https://tools.ostrails.eu/champion/sets/ + - **Code repository**: https://github.com/OSTrails/FAIR-Champion + - **Version**: Release v1 + - **Release**: https://github.com/OSTrails/FAIR-Champion/releases/tag/1.0.0 + - **License**: MIT diff --git a/docs/tools/FAIR_tools/FAIR-Validator.rst b/docs/tools/FAIR_tools/FAIR-Validator.rst new file mode 100644 index 0000000..f1bcee3 --- /dev/null +++ b/docs/tools/FAIR_tools/FAIR-Validator.rst @@ -0,0 +1,10 @@ +FAIR Validator +^^^^^^^^^^^^^^ + +The OpenAIRE Metadata Validator is a software tool designed to evaluate metadata records for research products (publications, datasets, software, and other outputs) against the OpenAIRE Guidelines, which define the minimum requirements for inclusion in the OpenAIRE Graph. In addition to guideline compliance, the tool is being extended with FAIR evaluation capabilities through the FAIR Validator, which builds on the OpenAIRE Guidelines assessment. The version presented here supports and implements the FAIR Reference Model defined by OSTrails. This release includes the source code of the tool. + + - **Persistent identifier**: not available yet + - **Code repository**: https://code-repo.d4science.org/MaDgIK/openaire-ostrails-api/ + - **Version**: Release v0.1.0 + - **Release**: https://code-repo.d4science.org/MaDgIK/openaire-ostrails-api/releases/tag/0.1.0 + - **License**: Apache-2.0 diff --git a/docs/tools/FAIR_tools/FAIROS.rst b/docs/tools/FAIR_tools/FAIROS.rst new file mode 100644 index 0000000..c61ae9a --- /dev/null +++ b/docs/tools/FAIR_tools/FAIROS.rst @@ -0,0 +1,12 @@ +FAIROS +^^^^^^ + +FAIROs is a FAIR assessment tool for [Research Objects](https://www.researchobject.org/ro-crate/). The tool uses external tools such as [F-UJI](https://f-uji.net/), [FOOPS](https://w3id.org/foops/) and [RSFC](https://github.com/oeg-upm/rsfc) to assess datasets, ontologies and software. The catalog contains the metrics and tests used to evaluate Research Objects. The source code with the FTR specification is in the branch dev-ostrails. + + - **Persistent identifier**: https://w3id.org/FAIROS/ + - **Zenodo link (latest release)**: https://doi.org/10.5281/zenodo.7795727 + - **Code repository**: https://github.com/oeg-upm/FAIR-Research-Object + - **Version**: 0.0.2 + - **Release**:https://github.com/oeg-upm/FAIR-Research-Object/releases/tag/v0.0.2 + - **License**: Apache-2.0 + - **Test and metric catalogue**: https://w3id.org/FAIROS/catalog diff --git a/docs/tools/FAIR_tools/FAIRsharing.rst b/docs/tools/FAIR_tools/FAIRsharing.rst new file mode 100644 index 0000000..4a6fee7 --- /dev/null +++ b/docs/tools/FAIR_tools/FAIRsharing.rst @@ -0,0 +1,110 @@ +.. _fairsharing-registry: + +FAIRsharing Registry +==================== + +Across all disciplines, there are thousands of repositories (databases and knowledge bases), as well as +community-developed standards for the identification, citation, and reporting of digital objects (DOs), +such as datasets, software, and research materials. Making the right choice is challenging, but understanding +this evolving landscape is essential: standards and repositories are fundamental pillars of the FAIR +Principles. + +FAIRsharing (`https://fairsharing.org/ `_) is a curated, informative, and educational +resource on data and metadata standards, inter-related to databases and data policies across all disciplines. +It guides: + +- **Consumers**, to discover, select, and use standards and repositories with confidence; +- **Producers**, to make their resources more discoverable, widely adopted, and cited; and +- **Third-party tools**, by providing trustworthy content to promote standards and databases. + +FAIRsharing is a core integration component within a variety of research data management tools, including +technical solutions for FAIR assessment and evaluation as well as data management plan (DMP) creation. It is +recommended within infrastructures such as **EOSC** and **ELIXIR**, as well as by research data management +communities including the **Research Data Alliance (RDA)**. + +FAIRsharing provides more than **40 richly described metadata fields and relationships**, including: + +- How standards are related to each other (e.g. which terminologies are required by discipline-specific formats), +- Which repositories implement specific standards, +- The maturity status of standards and databases, +- Which data policies recommend them, and +- Which digital object (DO) types and disciplines are in scope. + +All FAIRsharing information is available in a **machine-actionable format**, using DCAT and JSON, and can be +accessed via content negotiation and FAIRsharing APIs to support advanced queries. + +Community Engagement and Curation +--------------------------------- + +FAIRsharing has a strong user community and an ongoing **Community Champion Programme** +(`https://fairsharing.org/community_champions `_). This programme +brings together domain and discipline experts who: + +- Act as advocates for standards, databases, and policies for digital objects, +- Create educational material to support discovery, use, and adoption of these resources, and +- Enrich FAIRsharing content by improving the description and discoverability of standards, repositories, and policies. + +OSTrails Cluster representatives participate as Champions and collaborators, working with the programme to +advance open and FAIR data management within the project. + +FAIRsharing and the Assess-IF +----------------------------- + +The Assess-IF requires high-quality information on standards and digital object types. OSTrails Cluster +representatives therefore engage with FAIRsharing to: + +- **Curate FAIRsharing content**, ensuring that domain-agnostic and discipline-specific standards and data resources are represented according to Cluster usage, recommendations, and community best practices. This curation enables these resources to be used within FAIR assistance and evaluation workflows. +- **Curate FAIRassist content**, by registering and maintaining FAIR assistance benchmarks and associated components. These records are essential for the development of FAIR test workflows for OSTrails Clusters, as well as thematic and national pilots. +- **Create collections of resources**, which group standards and data resources to facilitate discovery and use by humans and machines. Collections are based on community best practices and are required to support each Cluster’s assessment process. + +Collections also provide graphical representations of Cluster requirements, illustrating relationships +among standards and repositories (for example, which terminologies are required by specific formats, or which +identifier schemes are used by a given repository). This approach fosters reuse of common standards and +repositories across Clusters, disciplines, and communities where appropriate. + +.. _fairassist-registry: + +FAIRassist Registry +------------------- + +The FAIRassist registry (`https://fairassist.org/registry `_), powered by +FAIRsharing, stores records with persistent identifiers (DOIs) relating to the **conceptual components of FAIR +assistance and evaluation**. + +FAIRassist and the FDP Index are complementary exemplar services that showcase: + +- Registration and sharing of the components of the Assess-IF, +- Assistance with their discoverability (based on digital object types, discipline specificity, or generic scope), and +- Delivery of information and documentation to guide and support the FAIR assessment process. + +In particular, FAIRassist complements the FDP registry of **software components** from the Assess-IF (tests and +algorithms) by registering the **conceptual components**, including: + +- FAIR Dimensions and Principles, +- Metrics, and +- Benchmarks, + +as well as their relationships and links to individual tests. + +Registration with FAIRassist and FDP is strongly recommended for transparency and FAIRness. This approach +supports ease of adoption while providing clear guidance on the formality and consistency expected within an +Interoperability Framework. Through content negotiation and FAIRsharing APIs, FAIRassist provides a rich set of +human-curated data to FAIR assessments in a machine-actionable DCAT/JSON format. + +Cross-linking and Ecosystem Integration +--------------------------------------- + +The cross-linking between FAIRsharing and FAIRassist enables the Assess-IF by connecting metrics and benchmarks +to the FAIRsharing graph of information, including: + +- The digital objects (e.g. datasets, terminologies) applicable to a given metric or benchmark, +- The expert communities or domains for which the metric or benchmark is relevant, +- The standards or policies involved in the FAIR evaluation, and +- The assessment tools or platforms that run the evaluations. + +Other tools within the OSTrails ecosystem that integrate with FAIRassist include: + +- **OSTrails Wizard** – creation of Assess-IF components, +- **FAIR Champion** – running benchmarks and registering software components, +- **FOOPS!** – creation of Assess-IF components for terminologies, +- **DSW**, **damap**, and **Argos** – tools for DMP creation and evaluation. diff --git a/docs/tools/FAIR_tools/FOOPS.rst b/docs/tools/FAIR_tools/FOOPS.rst new file mode 100644 index 0000000..ddfbebd --- /dev/null +++ b/docs/tools/FAIR_tools/FOOPS.rst @@ -0,0 +1,12 @@ +FOOPS! +^^^^^^ + +The Ontology Pitfall Scanner for FAIR (FOOPS!) is a FAIR assessment tool for vocabularies and ontologies. In this release, FOOPS! has been adapted to comply with the [FTR specification](https://w3id.org/ftr/). A catalog of test descriptions and metrics has been made available in https://w3id.org/foops/catalogue. The release contains the source code of the tools, as well as the machine-readable and human-readable documentation of all tests, metrics and benchmarks associated with the tool. + + - **Persistent identifier**: https://w3id.org/foops/ + - **Zenodo link (latest release)**: https://doi.org/10.5281/zenodo.14767999 + - **Code repository**: https://github.com/oeg-upm/fair_ontologies + - **Version**: 0.2.0 + - **Release**: https://github.com/oeg-upm/fair_ontologies/releases/tag/v0.2.0 + - **License**: Apache-2.0 + - **Catalog of tests and metrics**: https://w3id.org/foops/catalogue diff --git a/docs/tools/FAIR_tools/fairassist-principles-navigation.png b/docs/tools/FAIR_tools/fairassist-principles-navigation.png new file mode 100644 index 0000000..a1fea22 Binary files /dev/null and b/docs/tools/FAIR_tools/fairassist-principles-navigation.png differ diff --git a/docs/tools/FAIR_tools/fairassist-search-filter.png b/docs/tools/FAIR_tools/fairassist-search-filter.png new file mode 100644 index 0000000..aece2dd Binary files /dev/null and b/docs/tools/FAIR_tools/fairassist-search-filter.png differ diff --git a/docs/tools/SKG.rst b/docs/tools/SKG.rst new file mode 100644 index 0000000..58b5acb --- /dev/null +++ b/docs/tools/SKG.rst @@ -0,0 +1,15 @@ +OSTrails SKG Tools +==================== + +The following resources illustrate tools and services that implement, expose, or interoperate with the SKG-IF data model and/or SKG-IF OpenAPI. They are part of the FAIR Tools component and demonstrate how SKG-IF can be adopted across different infrastructures and domains. + +The following resources in this section are part of the SKG Tools component. + +.. toctree:: + :caption: Tools + :maxdepth: 1 + :titlesonly: + + OpenAIRE Graph SKG-IF API + RO-HUB SKG-IF API + CESSDA SKG-IF API diff --git a/docs/tools/SKG_tools/cessda.rst b/docs/tools/SKG_tools/cessda.rst new file mode 100644 index 0000000..13bf0b0 --- /dev/null +++ b/docs/tools/SKG_tools/cessda.rst @@ -0,0 +1,25 @@ + +CESSDA SKG-IF API +================= + +Overview +-------- + +For links to OpenAPI documentation, implemented endpoints and examples of filter usage: + + - `https://skg-if-staging.cessda.eu/ `__ + +Endpoints +--------- + + * `https://skg-if-staging.cessda.eu/products `__ – Returns studies from the CESSDA Data Catalogue (CDC). + * `https://skg-if-staging.cessda.eu/topics `__ – Returns topics from the European Language Social Science Thesaurus (ELSST). + +Current Status +-------------- + +Version 0.1.0 has been released with minor fixes since then. The Products endpoint may respond slowly but should return all CDC studies without any errors. + +.. note:: + + This is a staging environment intended for testing. Availability is not guaranteed, and services may be down without prior notice. Endpoints, data, and behavior are subject to change at any time. diff --git a/docs/tools/SKG_tools/openaire.rst b/docs/tools/SKG_tools/openaire.rst new file mode 100644 index 0000000..7c42fec --- /dev/null +++ b/docs/tools/SKG_tools/openaire.rst @@ -0,0 +1,13 @@ +OpenAIRE Graph API +=================== + +Overview +------------- + + - **Swagger API**:https://api.openaire.eu/graph/v3/api-docs/SKG-IF%20OpenAPI%20V1 + - **Endpoints**: + - https:....//skg-if/v1/products – Returns products matching criteria + - https:....//skg-if/v1/products/{local identifier} – Returns the product record with the given {local identifier} + - **Current Status**: + - Version 1.0.0 has been released as an initial draft, with the intent to extend to other endpoints serving the remaining entities. + diff --git a/docs/tools/SKG_tools/rohub.rst b/docs/tools/SKG_tools/rohub.rst new file mode 100644 index 0000000..4082143 --- /dev/null +++ b/docs/tools/SKG_tools/rohub.rst @@ -0,0 +1,85 @@ +ROHub API +========== + +.. page-authors:: + Raul Palma + +ROHub (https://www.rohub.org/) is an RO-Crate management platform that provides a holistic solution for the storage, lifecycle management and preservation of scientific investigations, campaigns and operational processes via research objects. +It makes these resources available to others, allows to publish and release them through a DOI, and allows to discover and reuse pre-existing scientific knowledge. +ROHub implements the RO-Crate specification and uses it as the standard format for serialising and exchanging research objects. +ROHub provides the backbone to a wealth of RO centric applications and interfaces across different scientific communities. +It is available via a public instance, and can provided also as a dedicated/private instance (Platform as a service) or on-premises. + +Architecture overview and integrations +------------------------------------------ +ROHub comprises a backend component, an IAM component, (meta-) data and resource storage components and a set of user interfaces. +The backend exposes a comprehensive REST API, which can be used by different applications. +The user interfaces, include a reference Web Portal and a Python library. +The ROHub portal provides a comprehensive user interface for the management and preservation of research objects, while the Python library works on top of the ROHub backend REST API, wrapping and abstracting the REST methods in user-friendly API methods that can be used, for instance, via Jupyter Notebooks. +Additionally, various external services are integrated or leverated in ROHub, including RO added value services as well as various EOSC services. +These include: +- Semantic enrichment and recommendation plus a set of extended analytic services. The former generate structured machine-readable metadata about the content of a research object including the main concepts and phrases, the entities and their type, and topical information from domains according to the Expert.ai linguistic knowledge graph, and generate recommendations based on the discovered metadata. The latter include the challenge and solution extraction, the Question Generation service, the claim analysis service, and the novelty scoring service +- Checklist service: provides access to the minim-based checklist evaluation of research objects, used to assess their quality for different purposes, e.g., completeness, accessibility or ready to release, and according to the needs of a particular community or application. +- Quality monitoring service: enables the evaluation of the RO through time by capturing discrete values provided by the checklist service in different moments of its evolution. +- FAIROs service: measures the FAIRness of Research Objects, by calculating the FAIRness of individual aggregated resources, including the Research Object itself, and then aggregating those results to calculate the over FAIR score. +- EGI check-in, the EOSC Identity and Access Management (IAM) service that connects federated Identity Providers (IdPs) with EOSC service providers. +- Zenodo. ROHub allows to release and share ro-crates via Zenodo. +- B2share. ROHub allows to release and share ro-crates via B2Share. +- B2drop. ROHub users have the possibility to use the default ROHub storage, or B2drop as their personal storage space where the resources uploaded to their research objects will be stored. B2drop resources are synchronized with the corresponding research objects in both ways. +- Notebooks. ROHub users can open and load the Jupyter notebooks in the ROs automatically in EGI Notebooks directly from ROHub and execute their methods/processing in an interactive computing environment (eproducible science). +- Replay. ROHub users can open and load automatically Jupyter notebooks and reproduce their associated computing environment with Replay, including any related input datasets, directly from the ROs in ROHub. (highest reproducible science) +- OpenAire/EOSC Research Graph. ROHub resources, particularly ROs, Jupyter notebooks and data cubes, are harvested in the graph, and thus they are findable directly from the EOSC marketplace. +- Argos. ROHub enables the creation of ROs from DMPs in Argos, leveraging and representing all the DMP information in machine-readable format, enabling researchers to shift their DMP into machine actionable DMPs, connected with the datasets themselves. +- ADAM. ROHub enables the aggregation of data cubes from ADAM by reference, leveraging all the available metadata available in ADAM to describe them in the RO. ROHub users can open and load data cubes in ADAM directly from ROHub for their usage and exploration + + +Authentication and Authorization +---------------------------------- +The ROHub Identity and Access Management (IAM) is based on Keycloak technology. +It allows users to authenticate to ROHub and enables the single sign-on across different various services. +The most important feature of ROHub IAM is that is integrated with EGI check-in AAI and with Pionier.ID. +The former allows the user to authenticate through the EGI check-in service that operates as a central hub to connect federated Identity Providers (IdPs) with EOSC service providers. +The latter allows access to the services of the PIONIER Consortium for Polish science and automatic membership in eduGain, which connects identity federations around the world, simplifying access to content, services and resources for the global research and education community. + + +SKG-IF implementation +------------------------ +Initial implementation (under testing) of OSTrails SKG-IF to expose RO-Crates as Scientific Knowledge Graphs, focused on research products. +This required the specification and implementation of the mapping of the RO-Crate metadata to the SKG-IF data model. +This will allow the integration and/or harvesting of RO-Crate metadata in other SKGs that will use this API to harvest metadata, like OpenAire that plans to use such API in the future for harvesting. +Currently, OpenAire SKG harvest metadata about RO-Crates (and other key resources) from ROHub via its OAI-PMH endpoint. + +Resources and identifiers +-------------------------- +Portal +~~~~~~~~ + - **Portal**: https://www.rohub.org/ + - **re3data.org persistent identifier**: http://doi.org/10.17616/R31NJN60 + - **FAIRSharing identifier**: https://fairsharing.org/4119 + - **Portal documentation**: https://reliance-eosc.github.io/rohub-portal-documentation/ + - **Version**: 4.0.2 + +API +~~~~~~~~ + - **API**: https://api.rohub.org/api/ + - **OpenAPI**: https://api.rohub.org/api/swagger/ + - **Redoc**: https://api.rohub.org/api/redoc/ + - **OAI-PMH endpoint**: https://api.rohub.org/api/oai2d/ + - **SPARQL endpoint**: https://rohub2020-api-virtuoso-route-rohub2020.apps.paas.psnc.pl/sparql/ + - **Version**: 2.1.81 + +Python library +~~~~~~~~~~~~~~~~ + - **Python library**: https://reliance-eosc.github.io/ROHUB-API_documentation/html/README.html + - **API library documentation**: https://reliance-eosc.github.io/ROHUB-API_documentation/html/index.html + - **API library example Jupyter Notebooks**: https://github.com/RELIANCE-EOSC/sample-notebooks + - **Repository**: https://github.com/oeg-upm/FAIR-Research-Object + - **License**: MIT + +support +~~~~~~~~ + - **ROHub in EOSC**: https://open-science-cloud.ec.europa.eu/resources/datasources/21.11166%2FBA1Ba2 + - **Tutorial**: https://reliance-eosc.github.io/ROHUB-API_documentation/html/tutorials.html + - **Training materias**: https://www.reliance-project.eu/adopters/ + - **Helpdesk**: https://support.pcss.pl/servicedesk/customer/portal/27 + - **support email**: support@rohub.org