From 8acc4e8077029e5c87ba9b002e91fec543436074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Such=C3=A1nek?= Date: Tue, 16 Dec 2025 16:18:41 +0100 Subject: [PATCH] Fix formatting and Sphinx build --- .editorconfig | 3 - CONTRIBUTING.md | 4 +- CONTRIBUTORS.yml | 7 + .../FAIR/Assessment-Recommended-API.rst | 118 +-- .../FAIR/FAIR-Test-Results-Vocabulary-FTR.rst | 8 +- .../FAIR/Guidance-Element-Specification.rst | 2 +- .../FAIR/index_catalogs_registries.rst | 10 - docs/commons/FAIR/index_standards.rst | 14 - docs/commons/dmp/API-specification.rst | 8 +- ...Austrian-FWF\342\200\223maDMP-mapping.rst" | 112 ++- .../mappings/Science-Europe-maDMP-mapping.rst | 685 +++++++++--------- docs/commons/dmp/mappings/index.rst | 8 +- docs/commons/resources.rst | 15 +- .../skg/mappings/Mapping-SKGIF-DDI.rst | 14 +- docs/commons/skg/mappings/index.rst | 8 +- docs/commons/skg/skg-commons.rst | 19 +- docs/commons/skg/skg-if-api-specification.rst | 6 +- docs/commons/skg/skg-if-entity-extension.rst | 36 +- docs/commons/skg/skg-if-metadata-model.rst | 2 +- docs/index.rst | 3 - docs/tools/FAIR.rst | 24 +- .../FAIR_tools/Catalogue-of-Benchmarks.rst | 13 +- .../FAIR-Assessment-Authoring-Tool.rst | 22 +- docs/tools/FAIR_tools/FAIR-Champion.rst | 2 +- docs/tools/FAIR_tools/FAIR-Validator.rst | 5 +- docs/tools/FAIR_tools/FAIROS.rst | 4 +- docs/tools/FAIR_tools/FAIRsharing.rst | 26 +- docs/tools/FAIR_tools/FOOPS.rst | 4 +- docs/tools/SKG.rst | 14 +- docs/tools/SKG_tools/lifewatch.rst | 5 +- docs/tools/SKG_tools/openaire.rst | 5 +- docs/tools/SKG_tools/rohub.rst | 5 +- 32 files changed, 579 insertions(+), 632 deletions(-) delete mode 100644 docs/commons/FAIR/index_catalogs_registries.rst delete mode 100644 docs/commons/FAIR/index_standards.rst 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 b0ebe54..d6c3e76 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,13 +39,15 @@ The code style is captured using [EditorConfig](https://editorconfig.org/), see ### Building the Documentation First, install the required dependencies (preferably in a virtual environment): -To activate the env in windows use the cmd and venv\Scripts\activate.bat + ```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 4e78415..37a11d7 100644 --- a/CONTRIBUTORS.yml +++ b/CONTRIBUTORS.yml @@ -60,3 +60,10 @@ Paolo Manghi: github: paolomanghi orcid: 0000-0001-7291-3210 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 diff --git a/docs/commons/FAIR/Assessment-Recommended-API.rst b/docs/commons/FAIR/Assessment-Recommended-API.rst index 8db1263..ba4599c 100644 --- a/docs/commons/FAIR/Assessment-Recommended-API.rst +++ b/docs/commons/FAIR/Assessment-Recommended-API.rst @@ -1,78 +1,80 @@ 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. +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/. +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 +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. +--------- + +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 + :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. + * - 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#" - } + { + "resource_identifier": "https://w3id.org/example#" + } .. list-table:: POST endpoints - :header-rows: 1 - :widths: 20 20 60 + :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 + * - 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 diff --git a/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst b/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst index 14c3a0e..e243041 100644 --- a/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst +++ b/docs/commons/FAIR/FAIR-Test-Results-Vocabulary-FTR.rst @@ -17,23 +17,17 @@ acting as a reference model that extends W3C standards such as 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. ---- diff --git a/docs/commons/FAIR/Guidance-Element-Specification.rst b/docs/commons/FAIR/Guidance-Element-Specification.rst index d911828..cfd0582 100644 --- a/docs/commons/FAIR/Guidance-Element-Specification.rst +++ b/docs/commons/FAIR/Guidance-Element-Specification.rst @@ -1,5 +1,5 @@ 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) `__. diff --git a/docs/commons/FAIR/index_catalogs_registries.rst b/docs/commons/FAIR/index_catalogs_registries.rst deleted file mode 100644 index d3b5798..0000000 --- a/docs/commons/FAIR/index_catalogs_registries.rst +++ /dev/null @@ -1,10 +0,0 @@ -FAIR Catalog and Registry --------------------------- - -The following resources in this section are part of the FAIR Commons component. - -.. toctree:: - :caption: Catalogs and Registries - :maxdepth: 1 - :titlesonly: - diff --git a/docs/commons/FAIR/index_standards.rst b/docs/commons/FAIR/index_standards.rst deleted file mode 100644 index 0e4bca4..0000000 --- a/docs/commons/FAIR/index_standards.rst +++ /dev/null @@ -1,14 +0,0 @@ -FAIR Standards ----------------- -The following resources in this section are part of the FAIR Commons component. - - -.. toctree:: - :caption: Standards - :maxdepth: 1 - :titlesonly: - - Guidance Element Specification - FAIR Test Results Vocabulary (FTR) - Assessment Recommended API - diff --git a/docs/commons/dmp/API-specification.rst b/docs/commons/dmp/API-specification.rst index 3887f5c..2e268db 100644 --- a/docs/commons/dmp/API-specification.rst +++ b/docs/commons/dmp/API-specification.rst @@ -6,13 +6,11 @@ OSTrails maDMP API Specification The API is developed jointly with the `Research Data Alliance maDMP API working group `_. -The charter of the group can be found `here `_. +The charter of the group can be found at the `RDA maDMP API WG page `_. -The API specification is in this repository - `click `_. +The API specification is in this GitHub repository: `RDA-DMP-Common/common-madmp-api `_. - - -The OpenAPI documentation can be accessed directly `here `_. +The OpenAPI documentation can be accessed directly at: `rda-dmp-common.github.io/common-madmp-api `_. 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" index 5fd4b78..e2ba08a 100644 --- "a/docs/commons/dmp/mappings/Austrian-FWF\342\200\223maDMP-mapping.rst" +++ "b/docs/commons/dmp/mappings/Austrian-FWF\342\200\223maDMP-mapping.rst" @@ -1,10 +1,10 @@ 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 @@ -16,12 +16,12 @@ Section: I General Information - 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/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 @@ -37,13 +37,13 @@ Section: I General Information 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/value, cost/title, - - + - Section: II Data Characteristics --------------------------------- @@ -58,34 +58,34 @@ Section: II Data Characteristics - 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/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 @@ -98,15 +98,15 @@ Section: III Documentation and Data Quality * - 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 @@ -119,11 +119,11 @@ Section: III Documentation and Data Quality - 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 @@ -137,20 +137,20 @@ Section: IV Data Storage, Sharing, and Long-Term Preservation - 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, @@ -158,7 +158,7 @@ Section: IV Data Storage, Sharing, and Long-Term Preservation /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 @@ -183,49 +183,47 @@ Section: IV Data Storage, Sharing, and Long-Term Preservation 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 @@ -237,31 +235,31 @@ Section: V Legal and Ethical Aspects - 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/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 @@ -274,14 +272,14 @@ Section: V Legal and Ethical Aspects * - 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 index dda9f90..5340109 100644 --- a/docs/commons/dmp/mappings/Science-Europe-maDMP-mapping.rst +++ b/docs/commons/dmp/mappings/Science-Europe-maDMP-mapping.rst @@ -1,392 +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 - - + :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 + :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 - - + :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: 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 - - - + :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 + :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 + :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 + :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 + - - :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/titl - host/url - distribution/description - distribution/data_access - - + :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 - - + :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 - - + :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 - + :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 - - \ No newline at end of file + :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 index 8575f5a..1f08713 100644 --- a/docs/commons/dmp/mappings/index.rst +++ b/docs/commons/dmp/mappings/index.rst @@ -4,8 +4,8 @@ maDMP mappings - *Planned resource to be developed* .. toctree:: - :maxdepth: 1 - :titlesonly: + :maxdepth: 1 + :titlesonly: - Science Europe maDMP mapping - Austrian FWF – maDMP mapping + Science Europe maDMP mapping + Austrian FWF – maDMP mapping diff --git a/docs/commons/resources.rst b/docs/commons/resources.rst index b665e86..efed865 100644 --- a/docs/commons/resources.rst +++ b/docs/commons/resources.rst @@ -14,17 +14,12 @@ This page embodies the OSTrails Commons, a collection of reusable resource accor The following resources in this section are part of the DMP Commons component. .. toctree:: - :maxdepth: 1 - :caption: Commons Resources - - DMP Commons - SKG Commons - FAIR Commons - - - - + :maxdepth: 1 + :caption: Commons Resources + 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 index d4ed6ae..fc10915 100644 --- a/docs/commons/skg/mappings/Mapping-SKGIF-DDI.rst +++ b/docs/commons/skg/mappings/Mapping-SKGIF-DDI.rst @@ -1422,7 +1422,7 @@ Topic when collected from DDI2.5 files | $.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. | +| | | | | | 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 | @@ -1431,7 +1431,7 @@ Topic when collected from DDI2.5 files | | | | | | /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/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 | @@ -1439,13 +1439,13 @@ Topic when collected from DDI2.5 files | | | | | | /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” |   | +| $.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 | 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 | +| 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 | @@ -1453,7 +1453,7 @@ Topic when collected from DDI2.5 files | | | | | | /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. | +| 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 | diff --git a/docs/commons/skg/mappings/index.rst b/docs/commons/skg/mappings/index.rst index c174682..fd21440 100644 --- a/docs/commons/skg/mappings/index.rst +++ b/docs/commons/skg/mappings/index.rst @@ -1,10 +1,10 @@ SKG-IF mappings -================== +=============== - *Planned resource to be developed* .. toctree:: - :maxdepth: 1 - :titlesonly: + :maxdepth: 1 + :titlesonly: - DDI SKG-IF mapping + DDI SKG-IF mapping diff --git a/docs/commons/skg/skg-commons.rst b/docs/commons/skg/skg-commons.rst index 063ea04..6a64119 100644 --- a/docs/commons/skg/skg-commons.rst +++ b/docs/commons/skg/skg-commons.rst @@ -1,15 +1,14 @@ SKG Commons ---------------- +----------- 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 + :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 index ae1ded9..3e00414 100644 --- a/docs/commons/skg/skg-if-api-specification.rst +++ b/docs/commons/skg/skg-if-api-specification.rst @@ -1,5 +1,5 @@ -OSTrails SKG-IF API Specification --------------------------------------- +OSTrails SKG-IF API Specification +--------------------------------- OSTrails led the definition of the SKG-IF API specification, which provides dedicated endpoints for each SKG-IF core entity and supports querying and filtering -More information can be found online `here `_. \ No newline at end of file +More information can be found online `here `_. diff --git a/docs/commons/skg/skg-if-entity-extension.rst b/docs/commons/skg/skg-if-entity-extension.rst index 1bef737..fbbf531 100644 --- a/docs/commons/skg/skg-if-entity-extension.rst +++ b/docs/commons/skg/skg-if-entity-extension.rst @@ -1,28 +1,28 @@ OSTrails SKG-IF Extensions ------------------------------------------ +-------------------------- Within the OSTrails context, a number of extensions have been submitted to the attention of the SKG-IF Working Group. The status of such ext-submissions is summarised in the table below: .. list-table:: - :header-rows: 1 + :header-rows: 1 - * - Acronym - - Scope - - Status - - Link/request + * - Acronym + - Scope + - Status + - Link/request - * - SRV - - New entity to model services - - Under development - - https://skg-if.github.io/ext-srv/ + * - SRV + - New entity to model services + - Under development + - https://skg-if.github.io/ext-srv/ - * - SKG-PROV - - Provenance tracking - - To be discussed - - https://github.com/skg-if/extensions/issues/4 + * - 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 \ No newline at end of file + * - 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 index de11472..1c6a327 100644 --- a/docs/commons/skg/skg-if-metadata-model.rst +++ b/docs/commons/skg/skg-if-metadata-model.rst @@ -1,5 +1,5 @@ OSTrails Metadata Model for SKGs ---------------------------------------------------- +-------------------------------- OSTrails contributed to the consolidation and complies to the JSON format defined by the SKG-IF. More information about the entities, their properties and relations can be found online `here `_. diff --git a/docs/index.rst b/docs/index.rst index 801c685..2cf7368 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,6 +46,3 @@ The documentation is structured as follows: other/contributing other/resources other/contributors - - - \ No newline at end of file diff --git a/docs/tools/FAIR.rst b/docs/tools/FAIR.rst index 9ca270e..996ef12 100644 --- a/docs/tools/FAIR.rst +++ b/docs/tools/FAIR.rst @@ -5,16 +5,16 @@ OSTrails FAIR Tools The following resources in this section are part of the FAIR Tools component. .. toctree:: - :caption: Tools - :maxdepth: 1 - :titlesonly: + :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 \ No newline at end of file + 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-Benchmarks.rst b/docs/tools/FAIR_tools/Catalogue-of-Benchmarks.rst index 8f372e3..c47a5fb 100644 --- a/docs/tools/FAIR_tools/Catalogue-of-Benchmarks.rst +++ b/docs/tools/FAIR_tools/Catalogue-of-Benchmarks.rst @@ -1,5 +1,5 @@ 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 @@ -22,17 +22,14 @@ Via content negotiation and various FAIRsharing APIs, this registry makes a rich 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). +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). +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 --------------------------- @@ -49,4 +46,4 @@ 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. \ No newline at end of file +connectivity among the search results. diff --git a/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst b/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst index e2e4059..6d1c2fa 100644 --- a/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst +++ b/docs/tools/FAIR_tools/FAIR-Assessment-Authoring-Tool.rst @@ -17,16 +17,16 @@ 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 `_. + 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). + 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. + Registers your generated metadata into the appropriate repository or registry, authoring your FAIR metadata automatically. Submissions ~~~~~~~~~~~ @@ -51,10 +51,10 @@ Step-by-Step Guide 1. Fill in the Questionnaire ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -1. Go to the dedicated environment for this 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. +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. @@ -66,7 +66,7 @@ Step-by-Step Guide 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 + * **JSON** – for registration in FAIRsharing * **Turtle (RDF)** – for generating a DCAT-compliant record 3. Submit Your Information @@ -83,13 +83,13 @@ Depending on your document format: .. note:: - *Why Use This Tool?* - FAIR assessment components are a specific subtype of records within the FAIRsharing registry. + *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 +If your assessment component is a **FAIR Test**, this submission will also register the test in the `OSTrails FAIR Data Point test index `_. References @@ -105,5 +105,5 @@ References Contact us ---------- -Any question or issue related to this workflow, please contact: +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 index 47d89d9..3a9b869 100644 --- a/docs/tools/FAIR_tools/FAIR-Champion.rst +++ b/docs/tools/FAIR_tools/FAIR-Champion.rst @@ -7,4 +7,4 @@ FAIR Champion is a general-purpose FAIR assessment tool intended to be used by a - 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 \ No newline at end of file +- License: MIT diff --git a/docs/tools/FAIR_tools/FAIR-Validator.rst b/docs/tools/FAIR_tools/FAIR-Validator.rst index ef9d9d4..ccd114a 100644 --- a/docs/tools/FAIR_tools/FAIR-Validator.rst +++ b/docs/tools/FAIR_tools/FAIR-Validator.rst @@ -1,5 +1,5 @@ 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. @@ -8,6 +8,3 @@ The OpenAIRE Metadata Validator is a software tool designed to evaluate metadata - 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 index fceac18..beddd49 100644 --- a/docs/tools/FAIR_tools/FAIROS.rst +++ b/docs/tools/FAIR_tools/FAIROS.rst @@ -1,9 +1,9 @@ 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/ +- 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 diff --git a/docs/tools/FAIR_tools/FAIRsharing.rst b/docs/tools/FAIR_tools/FAIRsharing.rst index 78e1848..4a6fee7 100644 --- a/docs/tools/FAIR_tools/FAIRsharing.rst +++ b/docs/tools/FAIR_tools/FAIRsharing.rst @@ -1,5 +1,7 @@ +.. _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), @@ -40,8 +42,7 @@ 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. +- 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. @@ -52,23 +53,17 @@ 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. +- **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 ------------------- @@ -79,8 +74,7 @@ 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 +- 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 diff --git a/docs/tools/FAIR_tools/FOOPS.rst b/docs/tools/FAIR_tools/FOOPS.rst index ee7babe..9d8c7d1 100644 --- a/docs/tools/FAIR_tools/FOOPS.rst +++ b/docs/tools/FAIR_tools/FOOPS.rst @@ -1,5 +1,5 @@ -FOOPS! -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +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. diff --git a/docs/tools/SKG.rst b/docs/tools/SKG.rst index 9251932..50827f9 100644 --- a/docs/tools/SKG.rst +++ b/docs/tools/SKG.rst @@ -1,13 +1,13 @@ OSTrails SKG Tools -=================== +================== The following resources in this section are part of the FAIR Tools component. .. toctree:: - :caption: Tools - :maxdepth: 1 - :titlesonly: + :caption: Tools + :maxdepth: 1 + :titlesonly: - OpenAIRE Graph SKG-IF API - RO-HUB SKG-IF API - LifeWatch Eric KG \ No newline at end of file + OpenAIRE Graph SKG-IF API + RO-HUB SKG-IF API + LifeWatch Eric KG diff --git a/docs/tools/SKG_tools/lifewatch.rst b/docs/tools/SKG_tools/lifewatch.rst index 2ca710b..4e3a293 100644 --- a/docs/tools/SKG_tools/lifewatch.rst +++ b/docs/tools/SKG_tools/lifewatch.rst @@ -1,5 +1,4 @@ LifeWatch ERIC Knowledge Graph for Research Planning and Tracking ------------------------------------------------------------------------- +----------------------------------------------------------------- - -TODO \ No newline at end of file +*TODO* diff --git a/docs/tools/SKG_tools/openaire.rst b/docs/tools/SKG_tools/openaire.rst index 6cf25f6..e9e5f3f 100644 --- a/docs/tools/SKG_tools/openaire.rst +++ b/docs/tools/SKG_tools/openaire.rst @@ -1,5 +1,4 @@ OpenAIRE Graph API ------------------------------------------------------------------------- +------------------ - -TODO \ No newline at end of file +*TODO* diff --git a/docs/tools/SKG_tools/rohub.rst b/docs/tools/SKG_tools/rohub.rst index 21f8800..0bd964c 100644 --- a/docs/tools/SKG_tools/rohub.rst +++ b/docs/tools/SKG_tools/rohub.rst @@ -1,5 +1,4 @@ RO-HUB API ------------------------------------------------------------------------- +---------- - -TODO \ No newline at end of file +*TODO*