From 389c52c1dea85c442a94e8ebe484ce1ec3fc0c00 Mon Sep 17 00:00:00 2001 From: tilfischer Date: Tue, 6 Aug 2024 10:16:40 +0200 Subject: [PATCH 1/3] fix: british englisch for licences --- docs/00_intro/10_fair.mdx | 2 +- docs/30_data/50_data_storage.mdx | 2 +- docs/40_smartlab/15_choose_eln.mdx | 2 +- docs/50_data_publication/10_repositories.mdx | 2 +- .../20_choose_repository/10_choose_repository.mdx | 6 +++--- docs/50_data_publication/20_choose_repository/50_nmrxiv.mdx | 2 +- .../20_choose_repository/60_radar4chem.mdx | 2 +- .../20_choose_repository/90_csd_icsd.mdx | 2 +- .../{30_licenses.mdx => 30_licences.mdx} | 6 +++--- docs/50_data_publication/50_data_availability_statement.mdx | 2 +- .../60_machine-readable_chemical_structures.mdx | 2 +- .../30_publishing_standards_infrastructure.mdx | 2 +- .../63_data_description_annotation/20_ontology.mdx | 6 +++--- 13 files changed, 19 insertions(+), 19 deletions(-) rename docs/50_data_publication/{30_licenses.mdx => 30_licences.mdx} (95%) diff --git a/docs/00_intro/10_fair.mdx b/docs/00_intro/10_fair.mdx index bfcb71d4..2542a204 100644 --- a/docs/00_intro/10_fair.mdx +++ b/docs/00_intro/10_fair.mdx @@ -124,7 +124,7 @@ Repositories should provide data publishers with the opportunity to include a pl #### R1.1. (meta)data are released with a clear and accessible data usage license -The metadata should include human and machine-readable use conditions, such as a [license](/docs/licenses). [Creative Commons](https://creativecommons.org/) licenses are commonly used for scientific data. [re3data](https://www.re3data.org/) lists whether a repository allows researchers to directly select a license or terms of use agreement when depositing data. At a minimum, repositories should allow researchers to add a license file. +The metadata should include human and machine-readable use conditions, such as a [licence](/docs/licences). [Creative Commons](https://creativecommons.org/) licences are commonly used for scientific data. [re3data](https://www.re3data.org/) lists whether a repository allows researchers to directly select a licence or terms of use agreement when depositing data. At a minimum, repositories should allow researchers to add a licence file. #### R1.2. (meta)data are associated with detailed provenance diff --git a/docs/30_data/50_data_storage.mdx b/docs/30_data/50_data_storage.mdx index f9df9b60..9644f0ad 100644 --- a/docs/30_data/50_data_storage.mdx +++ b/docs/30_data/50_data_storage.mdx @@ -52,7 +52,7 @@ Many of the requirements are often solved by dedicated [repositories](/docs/repo _see [RDMKit](https://rdmkit.elixir-europe.org/preserving)_ ::: -Documentation or conversion of files into long-term backup formats. The data-holding facility must for its part guarantee security, quality and availability. Consider any license regulations or data protection of personal data when releasing it to the public. +Documentation or conversion of files into long-term backup formats. The data-holding facility must for its part guarantee security, quality and availability. Consider any licence regulations or data protection of personal data when releasing it to the public. If you publish your data in public repositories, your data will also be preserved. diff --git a/docs/40_smartlab/15_choose_eln.mdx b/docs/40_smartlab/15_choose_eln.mdx index 5b451eeb..cc36060f 100644 --- a/docs/40_smartlab/15_choose_eln.mdx +++ b/docs/40_smartlab/15_choose_eln.mdx @@ -36,7 +36,7 @@ Therefore, choosing the right ELN is crucial for a successful implementation of |Category|Explanation| |:------------|:------------| -|License model|Commercial ELNs mostly use proprietary file formats, the source code is closed source and a license fee is charged. Open source ELNs are free of charge, use open standard formats, source code is openly accessible and further developed by an active developer community. Implementation and maintenance require the appropriate human resources.| +|Licence model|Commercial ELNs mostly use proprietary file formats, the source code is closed source and a licence fee is charged. Open source ELNs are free of charge, use open standard formats, source code is openly accessible and further developed by an active developer community. Implementation and maintenance require the appropriate human resources.| |Providing model|Software can be provided either in a cloud (SaaS - Software as a Service) or server-based for local installation at the customer's site (on-premises).| |File storage|Data storage in the cloud of the ELN provider (or their service provider, e.g. in the EU) or the possibility of storage on own local servers/in the own cloud are offered.| |Concept|Concept refers to the subject-specific orientation. Generic tools can be used in all subjects, but usually do not provide specific features, such as structure editors for chemistry.| diff --git a/docs/50_data_publication/10_repositories.mdx b/docs/50_data_publication/10_repositories.mdx index 2e925aa9..7b441f80 100644 --- a/docs/50_data_publication/10_repositories.mdx +++ b/docs/50_data_publication/10_repositories.mdx @@ -21,7 +21,7 @@ Repositories can be hosted at institutional servers or are provided by broader o A repository is constituted by a repository software and a database. Researchers transfer their data to the repository typically via a browser-based user interface, and/or the repository operators **harvest** the data from other platforms via appropriate protocols and interfaces. -Some, but not all, repositories curate and review the data before **ingestion** with regard to their content and quality, sometimes also regarding legal aspects (copyright, data protection, [licenses](/docs/licenses)). +Some, but not all, repositories curate and review the data before **ingestion** with regard to their content and quality, sometimes also regarding legal aspects (copyright, data protection, [licences](/docs/licences)). In order to allow data reuse by other researchers, [metadata](/docs/metadata), including [provenance information](/docs/provenance/), are required beside the actual data. Metadata describe the research data and provide information about its creation, the methods or software used as well as legal aspects. Metadata can be either added manually via a metadata editor or can be provided through other applications. The process to manually add metadata via a metadata editor can be compared to the process of submitting a manuscript to a publisher via the publishers submission system. diff --git a/docs/50_data_publication/20_choose_repository/10_choose_repository.mdx b/docs/50_data_publication/20_choose_repository/10_choose_repository.mdx index fd735eaa..28f27478 100644 --- a/docs/50_data_publication/20_choose_repository/10_choose_repository.mdx +++ b/docs/50_data_publication/20_choose_repository/10_choose_repository.mdx @@ -37,7 +37,7 @@ Based on the [criteria](https://doi.org/10.3897/rio.6.e55852) chosen by Task Are - [Inorganic Crystal Structure Database](/docs/csd_icsd/)\*
Field-specific repository for x-ray diffraction data of inorganic compounds, elements, minerals, intermetallic phases and ionic solids, operated by FIZ Karlsruhe. - [Joint CCDC/FIZ Access Structures Service](/docs/csd_icsd/)
Service that provides open access to the CSD Structure Depot, but not to all CSD data. -\*Resource for which a license agreement is required. +\*Resource for which a licence agreement is required. ## Further Repositories @@ -47,7 +47,7 @@ Based on the [criteria](https://doi.org/10.3897/rio.6.e55852) chosen by Task Are - [Zenodo](https://zenodo.org/)
Generic repository developed under the European OpenAIRE program, operated by CERN. - [EUDAT B2SHARE](https://sp.eudat.eu/catalog/resources/709c053d-3b3f-4c54-8ef4-6efeea387816)
Generic repository operated by a pan-european network consisting of more than 25 research organisations, data and computing centers. -\*Resource for which a license agreement is required. +\*Resource for which a licence agreement is required. ## Currently under Development within NFDI4Chem @@ -65,6 +65,6 @@ Further details of the repositories listed above can be found on the sub-pages o Main authors: [ORCID:0000-0001-7696-7662](https://orcid.org/0000-0001-7696-7662), [ORCID:0000-0003-4480-8661](https://orcid.org/0000-0003-4480-8661) and [ORCID:0000-0002-5035-7978](https://orcid.org/0000-0002-5035-7978) -_This page is licensed under a Creative Commons Universal ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)) Public Domain Dedication International License to allow for reuse of these lists._ +_This page is licensed under a Creative Commons Universal ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)) Public Domain Dedication International Licence to allow for reuse of these lists._ ![CC0 badge](/img/cc-zero.svg) diff --git a/docs/50_data_publication/20_choose_repository/50_nmrxiv.mdx b/docs/50_data_publication/20_choose_repository/50_nmrxiv.mdx index 7564b1b6..e88cf886 100644 --- a/docs/50_data_publication/20_choose_repository/50_nmrxiv.mdx +++ b/docs/50_data_publication/20_choose_repository/50_nmrxiv.mdx @@ -36,7 +36,7 @@ The immediate goal of nmrXiv is to integrate and execute the following objective ### Software Development -To develop nmrXiv based on a voluntarily FAIR, cloud-based infrastructure that uses freely shared source code and deployment methods. Apply industry-grade development practices to ensure platform reliability, safety, and efficacy. Use Continuous Improvement principles will ensure an always-on user experience and high reliability. Release the codebase and infrastructure details (including the development, documentation, and usage practices) through MIT Open Source License for openness. +To develop nmrXiv based on a voluntarily FAIR, cloud-based infrastructure that uses freely shared source code and deployment methods. Apply industry-grade development practices to ensure platform reliability, safety, and efficacy. Use Continuous Improvement principles will ensure an always-on user experience and high reliability. Release the codebase and infrastructure details (including the development, documentation, and usage practices) through MIT Open Source Licence for openness. More details about the platform architecture and related topics – [here](https://docs.nmrxiv.org/developer-guides/architecture.html) diff --git a/docs/50_data_publication/20_choose_repository/60_radar4chem.mdx b/docs/50_data_publication/20_choose_repository/60_radar4chem.mdx index dd0c3c6c..f524fb0c 100644 --- a/docs/50_data_publication/20_choose_repository/60_radar4chem.mdx +++ b/docs/50_data_publication/20_choose_repository/60_radar4chem.mdx @@ -32,7 +32,7 @@ _Research Data Repository for Chemistry_ ::: -RADAR4Chem is a **multidisciplinary** repository for the publication of research data from **all disciplines** of **chemistry**. It was created in 2022 and is hosted at FIZ Karlsruhe (Leibniz Institute for Information Infrastructure). RADAR4Chem is based on the established research data repository **RADAR Cloud**. RADAR Cloud is primarily used by academic institutions for institutional research data management (data archiving and publication). The use of **RADAR Cloud** is subject to a **fee** and requires the stipulation of a **contract**. **RADAR4Chem**, on the other hand, is exclusively directed to researchers in the field of chemistry at publicly funded research institutions and universities in Germany. **No contract** is required and **no fees** are charged. RADAR4Chem allows discipline- and format-independent publication and storage (**at least 25 years**) of **research data** from all disciplines of chemistry. It complements the already existing portfolio of discipline specific repositories and is e.g. ideally suited for cross-disciplinary data or datasets with a multitude of different data formats. RADAR4Chem is easy and low-threshold to use. The researchers are responsible for the upload, organisation, annotation, and curation of research data as well as the peer-review process (as an optional step) and finally their publication. Using the service requires [advising from FIZ Karlsruhe](https://www.nfdi4chem.de/index.php/2650-2/), registration to RADAR4Chem, and consent to the [RADAR4Chem license and usage instructions](https://radar.products.fiz-karlsruhe.de/sites/default/files/radar/docs/terms/License_and_User_Instructions_for_Data_Providers_RADAR4Chem.pdf). Authentication is supported after self-registration and via [DFN-AAI](https://doku.tid.dfn.de/en:dfnaai:start) ([Shibboleth](https://www.incommon.org/software/shibboleth/). **Metadata** are recorded using the internal [RADAR Metadata Schema](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/radar-metadatenschema) (based on [DataCite Metadata Schema 4.0](https://schema.datacite.org/)), which supports 10 **mandatory** and 13 **optional metadata fields**. Annotation can be made on the dataset level and on the individual files and folders level. A [user license](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/lizenzen-fuer-forschungsdaten) which indicates re-use rules for the data, must be defined for each dataset. Each published dataset receives a **DOI** which is registered with [DataCite](https://datacite.org/). RADAR Metadata uses a combination of controlled lists and free text entries. Author identification is ensured by ORCID iD and funder identification by [CrossRef Open Funder Registry](https://www.crossref.org/pdfs/about-funder-registry.pdf) (more interfacing options will be implemented in the future). Datasets can be easily linked with other digital resources (e.g. text publications) via a **“related identifier”**. To maximise data dissemination and discoverability, the metadata of published datasets are indexed in various formats (e.g. RADAR and DataCite) and offered for public metadata harvesting e.g. via an [OAI-provider](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/radar-oai-provider). The **research data** is **stored permanently** on magnetic tapes redundantly in three copies at different locations at the Steinbuch Centre for Computing (SCC) of the Karlsruhe Institute of Technology (KIT, 2 copies) and at the Centre for Information Services and High Performance Computing (ZIH) of the TU Dresden (1 copy). +RADAR4Chem is a **multidisciplinary** repository for the publication of research data from **all disciplines** of **chemistry**. It was created in 2022 and is hosted at FIZ Karlsruhe (Leibniz Institute for Information Infrastructure). RADAR4Chem is based on the established research data repository **RADAR Cloud**. RADAR Cloud is primarily used by academic institutions for institutional research data management (data archiving and publication). The use of **RADAR Cloud** is subject to a **fee** and requires the stipulation of a **contract**. **RADAR4Chem**, on the other hand, is exclusively directed to researchers in the field of chemistry at publicly funded research institutions and universities in Germany. **No contract** is required and **no fees** are charged. RADAR4Chem allows discipline- and format-independent publication and storage (**at least 25 years**) of **research data** from all disciplines of chemistry. It complements the already existing portfolio of discipline specific repositories and is e.g. ideally suited for cross-disciplinary data or datasets with a multitude of different data formats. RADAR4Chem is easy and low-threshold to use. The researchers are responsible for the upload, organisation, annotation, and curation of research data as well as the peer-review process (as an optional step) and finally their publication. Using the service requires [advising from FIZ Karlsruhe](https://www.nfdi4chem.de/index.php/2650-2/), registration to RADAR4Chem, and consent to the [RADAR4Chem license and usage instructions](https://radar.products.fiz-karlsruhe.de/sites/default/files/radar/docs/terms/License_and_User_Instructions_for_Data_Providers_RADAR4Chem.pdf). Authentication is supported after self-registration and via [DFN-AAI](https://doku.tid.dfn.de/en:dfnaai:start) ([Shibboleth](https://www.incommon.org/software/shibboleth/). **Metadata** are recorded using the internal [RADAR Metadata Schema](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/radar-metadatenschema) (based on [DataCite Metadata Schema 4.0](https://schema.datacite.org/)), which supports 10 **mandatory** and 13 **optional metadata fields**. Annotation can be made on the dataset level and on the individual files and folders level. A [user licence](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/lizenzen-fuer-forschungsdaten) which indicates re-use rules for the data, must be defined for each dataset. Each published dataset receives a **DOI** which is registered with [DataCite](https://datacite.org/). RADAR Metadata uses a combination of controlled lists and free text entries. Author identification is ensured by ORCID iD and funder identification by [CrossRef Open Funder Registry](https://www.crossref.org/pdfs/about-funder-registry.pdf) (more interfacing options will be implemented in the future). Datasets can be easily linked with other digital resources (e.g. text publications) via a **“related identifier”**. To maximise data dissemination and discoverability, the metadata of published datasets are indexed in various formats (e.g. RADAR and DataCite) and offered for public metadata harvesting e.g. via an [OAI-provider](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/radar-oai-provider). The **research data** is **stored permanently** on magnetic tapes redundantly in three copies at different locations at the Steinbuch Centre for Computing (SCC) of the Karlsruhe Institute of Technology (KIT, 2 copies) and at the Centre for Information Services and High Performance Computing (ZIH) of the TU Dresden (1 copy). Please note: currently, the free-of-charge use of RADAR4Chem is **limited to a maximum of 10 GB** storage volume per research project. Researchers from the NFDI4Chem community whose research data volume exceeds this free quota and are interested in using RADAR functions institution-wide or in archiving research data, can stipulate a [regular RADAR Cloud contract](https://radar.products.fiz-karlsruhe.de/en/radaragreementsprices/vertraege-preise). diff --git a/docs/50_data_publication/20_choose_repository/90_csd_icsd.mdx b/docs/50_data_publication/20_choose_repository/90_csd_icsd.mdx index 5fb6d8da..987d3137 100644 --- a/docs/50_data_publication/20_choose_repository/90_csd_icsd.mdx +++ b/docs/50_data_publication/20_choose_repository/90_csd_icsd.mdx @@ -20,7 +20,7 @@ _Joint CCDC/FIZ access structures service_ /> :::info Note: -Link to [CSD](https://www.ccdc.cam.ac.uk/solutions/software/webcsd/) (requires license) [ICSD](https://icsd.fiz-karlsruhe.de/) (requires license) and [Joint CCDC/FIZ Access Structure](https://www.ccdc.cam.ac.uk/structures/) that provides open access to the CSD Structure Depot, but not all CSD data. +Link to [CSD](https://www.ccdc.cam.ac.uk/solutions/software/webcsd/) (requires licence) [ICSD](https://icsd.fiz-karlsruhe.de/) (requires licence) and [Joint CCDC/FIZ Access Structure](https://www.ccdc.cam.ac.uk/structures/) that provides open access to the CSD Structure Depot, but not all CSD data. CSD: Link to [FAIRsharing](https://doi.org/10.25504/FAIRsharing.vs7865) Link to [re3data](http://doi.org/10.17616/R36011) diff --git a/docs/50_data_publication/30_licenses.mdx b/docs/50_data_publication/30_licences.mdx similarity index 95% rename from docs/50_data_publication/30_licenses.mdx rename to docs/50_data_publication/30_licences.mdx index 22b28881..f7419ed8 100644 --- a/docs/50_data_publication/30_licenses.mdx +++ b/docs/50_data_publication/30_licences.mdx @@ -1,11 +1,11 @@ --- -title: "Licenses" -slug: "/licenses" +title: "Licences" +slug: "/licences" --- import useBaseUrl from "@docusaurus/useBaseUrl"; -# Licenses +# Licences In order to provide you with some helpful information, we have compiled introductory links on this topic. diff --git a/docs/50_data_publication/50_data_availability_statement.mdx b/docs/50_data_publication/50_data_availability_statement.mdx index ec52b097..242efb14 100644 --- a/docs/50_data_publication/50_data_availability_statement.mdx +++ b/docs/50_data_publication/50_data_availability_statement.mdx @@ -54,7 +54,7 @@ Please note that data availability statements such as _'data available on reques - [Joint Declaration of Data Citation Principles](https://doi.org/10.25490/a97f-egyk) - [Data Access Committee - European Genome-Phenome Archive](https://ega-archive.org/submission/data_access_committee) -_This page is licensed under a Creative Commons Universal ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)) Public Domain Dedication International License._ +_This page is licensed under a Creative Commons Universal ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)) Public Domain Dedication International Licence._ ![CC0 badge](/img/cc-zero.svg) diff --git a/docs/50_data_publication/60_machine-readable_chemical_structures.mdx b/docs/50_data_publication/60_machine-readable_chemical_structures.mdx index aa6b26c2..b18c023c 100644 --- a/docs/50_data_publication/60_machine-readable_chemical_structures.mdx +++ b/docs/50_data_publication/60_machine-readable_chemical_structures.mdx @@ -114,7 +114,7 @@ Templates for such a table containing the minimum recommended columns are provid If the experimental work is documented in an [ELN](/docs/eln), these information could also be provided by the ELN system. Chemotion ELN generates [SMILES](/docs/smiles), [InChI](/docs/inchi), InChIKey as well as RInChI and RInChIKey for compounds and reactions. These information are also available in Chemotion Repository i.e. such a supplementary table is not required with structured, field-specific repositories such as Chemotion Repository, while datasets in generic repositories will profit from such a table. ::: -_This page is licensed under a Creative Commons Universal ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)) Public Domain Dedication International License._ +_This page is licensed under a Creative Commons Universal ([CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/deed.en)) Public Domain Dedication International Licence._ ![CC0 badge](/img/cc-zero.svg) diff --git a/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx b/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx index fb72d19e..d81da7a0 100644 --- a/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx +++ b/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx @@ -126,7 +126,7 @@ In line with grouping licences between software and datasets, pointing authors t *Research data repositories should suggest licences such as CC0 or CC BY by pre-selecting such a licence rather than more restrictive licences such as CC BY-SA or even CC BY-NC-ND, which can inhibit reuse.* ::: -Shared data should be as **open as possible, as closed as necessary** with the intent of allowing and enabling others to reuse and build upon the work. Thus, encouraging rather open licences such as **[CC0](https://creativecommons.org/public-domain/cc0/)** and **[CC BY](https://creativecommons.org/licences/by/4.0/)** as opposed to more restrictive licences such as [CC BY-SA](https://creativecommons.org/licences/by-sa/4.0/) or even [CC BY-NC-ND](https://creativecommons.org/licences/by-nc-nd/4.0/). Such restrictive licenses can make data reuse difficult. +Shared data should be as **open as possible, as closed as necessary** with the intent of allowing and enabling others to reuse and build upon the work. Thus, encouraging rather open licences such as **[CC0](https://creativecommons.org/public-domain/cc0/)** and **[CC BY](https://creativecommons.org/licences/by/4.0/)** as opposed to more restrictive licences such as [CC BY-SA](https://creativecommons.org/licences/by-sa/4.0/) or even [CC BY-NC-ND](https://creativecommons.org/licences/by-nc-nd/4.0/). Such restrictive licences can make data reuse difficult. ### Creators and Contributors diff --git a/docs/60_topics/63_data_description_annotation/20_ontology.mdx b/docs/60_topics/63_data_description_annotation/20_ontology.mdx index e0538d8c..65f10fcc 100644 --- a/docs/60_topics/63_data_description_annotation/20_ontology.mdx +++ b/docs/60_topics/63_data_description_annotation/20_ontology.mdx @@ -47,15 +47,15 @@ Here we can see that these ontologies have different scopes, which means they on This tabular overview lists the suitable ontologies with regard to: - their general research domain, -- their open access license, +- their open access licence, - the possibility of reusing them in a modular way (whereas a BFO alignment and OBO compatibility indicates an increased possibility), - and, their use in known applications. -| Ontology | Domain | License | Modularity | Used in | +| Ontology | Domain | Licence | Modularity | Used in | | ------------------------------------------------------------------------------ | ------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | | [ChEBI](https://www.ebi.ac.uk/ols/ontologies/chebi) | chemistry | [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) | BFO & OBO based | YMDB, HMDB, PubChem, MassBank, KNApSAcK, UM-BBD, GMD, SMID-DB | | [CHIRO](https://terminology.nfdi4chem.de/ts/ontologies/chiro) | chemistry | [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) | BFO & OBO based | unknown | -| [ChemOnt](http://classyfire.wishartlab.com/downloads) | chemistry | custom OA license | subsumable under BFO's _material entity_ | YMDB, HMDB, T3DB, ECMDB, DrugBank,PubChem, ChEBI, LIPID MAPS, MoNA | +| [ChemOnt](http://classyfire.wishartlab.com/downloads) | chemistry | custom OA licence | subsumable under BFO's _material entity_ | YMDB, HMDB, T3DB, ECMDB, DrugBank,PubChem, ChEBI, LIPID MAPS, MoNA | | [CHEMINF](https://terminology.nfdi4chem.de/ts/ontologies/cheminf) | chemistry | [CC-BY 3.0](https://creativecommons.org/licenses/by/3.0/) | BFO & OBO based | PubChem, Open PHACTS | | [CHMO](https://terminology.nfdi4chem.de/ts/ontologies/chmo) | chemistry | [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) | BFO & OBO based | Chemotion, Allotrope™ | | [MOP](https://terminology.nfdi4chem.de/ts/ontologies/mop) | chemistry | [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) | BFO & OBO based | RXNO | From d934d1dadd6133e29ae83001da94d05384fe9810 Mon Sep 17 00:00:00 2001 From: tilfischer Date: Tue, 6 Aug 2024 12:03:52 +0200 Subject: [PATCH 2/3] feat: extension of licence page --- docs/50_data_publication/30_licences.mdx | 26 ++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/50_data_publication/30_licences.mdx b/docs/50_data_publication/30_licences.mdx index f7419ed8..13685c47 100644 --- a/docs/50_data_publication/30_licences.mdx +++ b/docs/50_data_publication/30_licences.mdx @@ -7,18 +7,28 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; # Licences -In order to provide you with some helpful information, we have compiled introductory links on this topic. +Licences for research data often cause confusion among researchers. One of the main reasons for this is the interplay between **licences used for research data** and the requirements for referencing previous scientific work on which the current work is based, in accordance with the [Guidelines for Safeguarding Good Scientific Practice (DFG Code)](https://wissenschaftliche-integritaet.de/en/code-of-conduct/). -- [**Choosing an open license**](https://heidiseibold.ck.page/posts/choosing-an-open-license) as a researcher - overview. -- [**Creative Commons overview**](https://creativecommons.org/share-your-work/cclicenses/) -- [**Comprehensive overview for chemists**](https://books.ub.uni-heidelberg.de/heibooks/catalog/book/979/chapter/13728) (in german) -- **[Publishing research data](https://forschungsdaten.info/themen/rechte-und-pflichten/forschungsdaten-veroeffentlichen/)** (in german) -- **[Open Data Commons](https://opendatacommons.org/licenses/odbl/)** +The DFG Code requires researchers to cite original sources, i.e. to include original sources in reference sections. Providing a licence for research data is a way to provide permission to share and reuse the data. +Work on dedicated licences for research data is ongoing. Until these licences are available, we recommend switching to [Creative Commons]((https://creativecommons.org/)) licences, which were developed for the licensing of creative works. +:::info Recommendation: +NFDI4Chem recommends the use the least restritive [Creative Commons](https://creativecommons.org/) licences such as [CC0](https://creativecommons.org/public-domain/cc0/) and [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en) +::: +:::danger Notice: +As a first starting point for further information, we strongly recommend the page on [Licenses for research data](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/lizenzen-fuer-forschungsdaten) provided by FIZ Karlsruhe, which also includes information on certain rights that authors cannot waive in Germany, that copyright only protects personal intellectual creations, and that isolated research data are not protected by copyright. +::: - - +Disclaimer: It should be checked on a case-by-case basis whether or not research data is protected by copyright. If the copyright status is unclear, please contact a legal professional at your institution. +In order to provide you with further helpful information, we have compiled a list of links: +- [Heidi Seibold - Choosing an open license](https://heidiseibold.ck.page/posts/choosing-an-open-license) +- [Forschungsdaten.info - Forschungsdaten Veröffentlichen](https://forschungsdaten.info/themen/rechte-und-pflichten/forschungsdaten-veroeffentlichen/) (in German) +- [Forschungsdaten.info - Urheberrecht](https://forschungsdaten.info/themen/rechte-und-pflichten/urheberrecht/) (in German) +- [Creative Commons - About CC Licenses](https://creativecommons.org/share-your-work/cclicenses/) +- [Creative Commons - License Chooser](https://creativecommons.org/choose/) +- [Forschungsdaten in den Naturwissenschaften: Eine urheberrechtliche Bestandsaufnahme mit ihren Implikationen für universitäres FDM](https://doi.org/10.11588/heibooks.979.c13728) (in German) +- [Open Knowledge Foundation - Open Data Commons](https://opendatacommons.org/licenses/odbl/) From af775950527b050af14fa9e19b16529c66d41276 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Ctilfischer=E2=80=9D?= <“tillmann.fischer.ipb@gmail.com”> Date: Wed, 7 Aug 2024 11:15:08 +0200 Subject: [PATCH 3/3] fix: proofreading pub std and licences --- docs/50_data_publication/30_licences.mdx | 12 ++--- .../10_publishing_standards_authors.mdx | 16 +++---- .../20_publishing_standards_publishers.mdx | 22 +++++----- .../28_publishing_standards_intro.mdx | 6 +-- ...30_publishing_standards_infrastructure.mdx | 44 +++++++++---------- 5 files changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/50_data_publication/30_licences.mdx b/docs/50_data_publication/30_licences.mdx index 13685c47..56b3b702 100644 --- a/docs/50_data_publication/30_licences.mdx +++ b/docs/50_data_publication/30_licences.mdx @@ -7,21 +7,21 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; # Licences -Licences for research data often cause confusion among researchers. One of the main reasons for this is the interplay between **licences used for research data** and the requirements for referencing previous scientific work on which the current work is based, in accordance with the [Guidelines for Safeguarding Good Scientific Practice (DFG Code)](https://wissenschaftliche-integritaet.de/en/code-of-conduct/). +Licences for research data often cause confusion among researchers. One of the main reasons for this is the interplay between **licences used for research data** and the requirements for referencing previous scientific work on which the current work is based, in accordance with the [Guidelines for Safeguarding Good Scientific Practice (DFG Code of Conduct)](https://wissenschaftliche-integritaet.de/en/code-of-conduct/). -The DFG Code requires researchers to cite original sources, i.e. to include original sources in reference sections. Providing a licence for research data is a way to provide permission to share and reuse the data. +The DFG Code of Conduct requires researchers to cite original sources, i.e. to include original sources in reference sections. Providing a licence for research data is a way to provide permission to share and reuse the data. -Work on dedicated licences for research data is ongoing. Until these licences are available, we recommend switching to [Creative Commons]((https://creativecommons.org/)) licences, which were developed for the licensing of creative works. +Work on dedicated licences for research data is ongoing. Until these licences are available, we recommend switching to [Creative Commons]((https://creativecommons.org/)) licences, which were developed to license creative works. :::info Recommendation: -NFDI4Chem recommends the use the least restritive [Creative Commons](https://creativecommons.org/) licences such as [CC0](https://creativecommons.org/public-domain/cc0/) and [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en) +NFDI4Chem recommends the use the least restrictive [Creative Commons](https://creativecommons.org/) licences such as [CC0](https://creativecommons.org/public-domain/cc0/) and [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/deed.en) ::: :::danger Notice: As a first starting point for further information, we strongly recommend the page on [Licenses for research data](https://radar.products.fiz-karlsruhe.de/en/radarfeatures/lizenzen-fuer-forschungsdaten) provided by FIZ Karlsruhe, which also includes information on certain rights that authors cannot waive in Germany, that copyright only protects personal intellectual creations, and that isolated research data are not protected by copyright. ::: -Disclaimer: It should be checked on a case-by-case basis whether or not research data is protected by copyright. If the copyright status is unclear, please contact a legal professional at your institution. +Disclaimer: It should be checked on a case-by-case basis whether research data is protected by copyright. If the copyright status is unclear, please contact a legal professional at your institution. In order to provide you with further helpful information, we have compiled a list of links: @@ -31,4 +31,4 @@ In order to provide you with further helpful information, we have compiled a lis - [Creative Commons - About CC Licenses](https://creativecommons.org/share-your-work/cclicenses/) - [Creative Commons - License Chooser](https://creativecommons.org/choose/) - [Forschungsdaten in den Naturwissenschaften: Eine urheberrechtliche Bestandsaufnahme mit ihren Implikationen für universitäres FDM](https://doi.org/10.11588/heibooks.979.c13728) (in German) -- [Open Knowledge Foundation - Open Data Commons](https://opendatacommons.org/licenses/odbl/) +- [Open Knowledge Foundation - Open Data Commons](https://opendatacommons.org/licenses/odbl/) \ No newline at end of file diff --git a/docs/50_data_publication/70_publishing_standards/10_publishing_standards_authors.mdx b/docs/50_data_publication/70_publishing_standards/10_publishing_standards_authors.mdx index 35149fb3..4f022ce3 100644 --- a/docs/50_data_publication/70_publishing_standards/10_publishing_standards_authors.mdx +++ b/docs/50_data_publication/70_publishing_standards/10_publishing_standards_authors.mdx @@ -3,19 +3,19 @@ title: "For Authors" slug: "/publishing_standards_authors" --- -### Use ORCID iD to Identifiy Authors and ROR to Identifiy Institutions +### Use ORCID iD to identifiy authors and ROR to identifiy institutions :::tip Standard _Authors should provide their ORCID iD to identify the authors/creators and contributors, and their ROR identifier to identify the institution to which they are affiliated._ ::: -ORCID iDs allow authors to be uniquely identified, whereas author names may not be unique, may change, or may have different ordering conventions depending on cultural differences. Similarly, affiliations can vary according to style and granularity. In order to uniquely identify the institutions to which authors are affiliated, the ROR identifier should be provided. Please note that the ROR identifier is not intended to resolve down to the departmental level. Nevertheless, both identifiers improve findability. +ORCID iDs allow authors to be uniquely identified, whereas author names may not be unique, may change, or may have different ordering conventions depending on cultural differences. Similarly, affiliations can vary according to style and granularity. In order to uniquely identify the institutions to which authors are affiliated, the ROR identifier should be provided. Please note that the ROR identifier is not intended to resolve down to the department level, as the stability of institutional units decrease, the finer the granularity. Both identifiers improve findability as well as traceability of your scientific work. -### How to use Dataset PIDs in Scientific Articles +### How to use dataset PIDs in scientific articles During deposition of research data, a [persistent identifier (PID)](/docs/pid) is assigned to the data. Authors should use PIDs in their scientific article for interlinking and referencing in **two main ways**: -#### How to use Dataset PIDs of own Datasets in Scientific articles +#### How to use dataset PIDs of own datasets in scientific articles :::tip Standard _Authors should add the PID of their corresponding dataset(s) to the data availability statement and should add PIDs of dataset(s) to the reference section in order to specifically cite dataset(s)._ @@ -27,7 +27,7 @@ For corresponding data, i.e. directly underlying the results reported in the art This distinction is important, because **the link** to the dataset in CrossRef's DOI metadata of scientific articles **is differently set**, depending on whether the dataset is a directly related source of information or a specifically referenced resource. ::: -#### How to use Dataset PIDs for Datasets by other Researchers in Scientific articles +#### How to use dataset PIDs for datasets by other researchers in scientific articles :::tip Standard _Authors should include PIDs for datasets published by other researchers that have been reused in the references, rather than citing the corresponding article._ @@ -35,7 +35,7 @@ _Authors should include PIDs for datasets published by other researchers that ha For datasets published by other researchers and reused in a study, include the dataset PID in the reference section of the manuscript and cite within the text accordingly. -### How to Link Datasets to their Corresponding Scientific Article +### How to link datasets to their corresponding scientific article :::tip Standard _Researchers should link their datasets to be published to their corresponding articles by adding the article DOI to the dataset's DataCite metadata as a related identifier._ @@ -43,13 +43,13 @@ _Researchers should link their datasets to be published to their corresponding a Research data repositories offer the option to add a related identifier to link datasets to related resources, such as a corresponding article. This considerably enhances the [FAIRness](/docs/fair/) of datasets, mainly the findability ([F2](/docs/fair/#f2-data-are-described-with-rich-metadata-defined-by-r1-below)) as well as the interoperability ([I3](/docs/fair/#i3-metadata-include-qualified-references-to-other-metadata)). -### Usage of Relation Type for Linking Datasets with Scientific Articles +### Usage of relation type for linking datasets with scientific articles :::tip Standard _Researchers should link their datasets to be published to their corresponding articles using the relation type `IsSupplementTo`._ ::: -According to the [DataCite Metadata Schema](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/), [`IsCitedBy`](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#iscitedby) and [`IsSupplementTo`](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#issupplementto) are both recommended for discovery. For published articles, [CrossRef's documentation on relationships](https://www.crossref.org/documentation/schema-library/markup-guide-metadata-segments/relationships/) recommends that `isSupplmenetTo` should be used to link datasets generated as part of research results. +According to the [DataCite Metadata Schema](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/), [`IsCitedBy`](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#iscitedby) and [`IsSupplementTo`](https://datacite-metadata-schema.readthedocs.io/en/4.5/appendices/appendix-1/relationType/#issupplementto) are both recommended for discovery. For published articles, [CrossRef's documentation on relationships](https://www.crossref.org/documentation/schema-library/markup-guide-metadata-segments/relationships/) recommends that `isSupplmenetTo` should be used to link datasets generated as part of research results. Please note that some repositories automatically detect whether the linked object is an article or some other dataset published in another repository, and therefore don't require authors to specify a relation(ship) type. ### Usage of Collection DOIs diff --git a/docs/50_data_publication/70_publishing_standards/20_publishing_standards_publishers.mdx b/docs/50_data_publication/70_publishing_standards/20_publishing_standards_publishers.mdx index e2743bc9..d7b59020 100644 --- a/docs/50_data_publication/70_publishing_standards/20_publishing_standards_publishers.mdx +++ b/docs/50_data_publication/70_publishing_standards/20_publishing_standards_publishers.mdx @@ -3,7 +3,7 @@ title: "For Academic Publishers" slug: "/publishing_standards_publishers" --- -### Recommendations for Trusted, Chemistry-friendly Repositories +### Recommendations for trusted, chemistry-friendly repositories :::tip Standard *Journals should recommend trusted, chemistry-friendly research data repositories.* @@ -11,15 +11,15 @@ slug: "/publishing_standards_publishers" To assist authors in selecting **well-established and community-specific [repositories](/docs/repositories/)** for their research data, [trusted chemistry friendly repositories](/docs/choose_repository/) should be recommended by journals. These should be included within the author guidelines or the data policies. -### Recommendations to Include Data Availability Statements +### Recommendations to include data availability statements :::tip Standard *Journals should recommend that authors provide a data availability statement. Author guidelines should also provide templates for illustration.* ::: -[Templates](/docs/data_availability_statement/#templates-for-data-availability-statements) for [**data availability statements**](/docs/data_availability_statement) or a similarly termed section should be made available to authors in the journal's author guidelines. This guides authors in correctly submitting underlying data with their manuscript and effectively communicating how to find and access the data by including the DOI or other PID, enabling the FAIR principles (e.g. [A1](docs/fair#a1-metadata-are-retrievable-by-their-identifier-using-a-standardized-communications-protocol), [I3](/docs/fair#i3-metadata-include-qualified-references-to-other-metadata)). It should also be mentioned whether templates are selectable and information should be provided via the manuscript submission system. +[Templates](/docs/data_availability_statement/#templates-for-data-availability-statements) for [**data availability statements**](/docs/data_availability_statement) or a similarly termed section should be made available to authors in the journal's author guidelines. This guides authors in correctly submitting underlying data with their manuscript and effectively communicating how to find and access the data by including the DOI or other PID, enabling the FAIR principles (e.g. [A1](docs/fair#a1-metadata-are-retrievable-by-their-identifier-using-a-standardized-communications-protocol), [I3](/docs/fair#i3-metadata-include-qualified-references-to-other-metadata)). It should also be mentioned whether the templates are selectable and the information should be provided via the manuscript submission system or whether this information should be manually inserted into the initially submitted manuscript by the authors. -### Data Availability Statements and Manuscript Submission Systems +### Data availability statements and manuscript submission systems :::tip Standard *Journals should add a data availability statement to published articles and collect the necessary information through their submission systems.* @@ -27,7 +27,7 @@ To assist authors in selecting **well-established and community-specific [reposi [Templates](/docs/data_availability_statement/#templates-for-data-availability-statements) for [**data availability statements**](/docs/data_availability_statement) or a similarly termed section should also be added to the manuscript submission system. Once a template has been selected by the submitter, the data availability statement should be editable to allow authors to add additional information, such as what data are included in the dataset, similar to what is currently often mentioned in the section on supporting information PDF files. The submission system should then require the submitter to provide the necessary information, such as the DOI (specified as [DOI name](https://www.doi.org/doi-handbook/HTML/doi-name-syntax2.html) e.g. `10.1000/182` or as a URL i.e. including a resolver e.g. `https://doi.org/10.1000/182` ), repository name, third party name and contact information, or reasons for restricted access and information on how to access a dataset, depending on the template used. -### Link Datasets to Articles in CrossRef DOI Metadata +### Link datasets to articles in CrossRef DOI metadata :::tip Standard *Journals should use the information available in data availability statements to enhance CrossRef DOI metadata by linking articles to datasets.* @@ -40,7 +40,7 @@ In XML: - Dataset in . + Dataset in <<>>. 10.prefix/suffix @@ -51,7 +51,7 @@ identifier-type="doi">10.prefix/suffix In agreement with [Crossref's documentation on **linking datasets** to published items](https://www.crossref.org/documentation/schema-library/markup-guide-metadata-segments/relationships/), the relationship type `isSupplementedBy` should be used. -### Add Data Publications to Prior Publication Policy +### Add data publications to prior publication policy :::tip Standard *Journal author guidelines should explicitly encourage pre-submission of datasets.* @@ -63,7 +63,7 @@ Similar to the publication of preprints, journal author guidelines should allow A disadvantage of pre-submission is that researchers cannot link the dataset to the manuscript, as the manuscript has not yet been published and no DOI has been registered. The metadata of the dataset must then be manually updated by the authors after the article has been published. Datasets with status *under review* are one way to overcome this disadvantage (see below). ::: -### Recommendations to Include Research Data in the Review Process +### Recommendations to include research data in the review process :::tip Standard *Journal author guidelines should explicitly encourage research data to be included in the review process.* @@ -71,13 +71,13 @@ A disadvantage of pre-submission is that researchers cannot link the dataset to Some repositories have an *under review* status alongside the *draft* and *published* statuses. A dataset *under review* is not editable and not yet published, i.e. it does not have a DOI registered. Therefore, the DOI cannot be validated. Nonetheless, the dataset has an internally reserved DOI and is accessible via a URL to provide access to editors and reviewers. This allows research data to be included in the review process. The URL to access the dataset should be requested by the submission system so that it can be forwarded to editors and reviewers. -### Encourage Authors to Publish Datasets prior Publishing Articles +### Encourage authors to publish datasets *under review* prior the articles gets published :::tip Standard -*Journal author guidelines should require that datasets under review to be published prior to the publication of the associated article.* +*Journal author guidelines should require that datasets with status under review to be published prior to the publication of the associated article.* ::: -To assist in automated workflows, such as linking the datasets to the published article through their respective PIDs, **datasets *under review* should be published prior to the publication of the article**. Once a manuscript has been accepted, the authors should be informed to publish their dataset *under review*. This ensures that the data has a registered DOI when the article gets published. Consequently, journals can run quality control checks on the provided DOI such as validation. This process must be explicitly communicated with authors through the author guidelines, yet, can also be included within other communication upon acceptance. Contemporaneous, the DOI for the article should be provided so that authors can include this information in their dataset's metadata prior to the publication of the dataset. Finally, the article is published, and its DOI is registered. +To assist in automated workflows, such as linking the datasets to the published article through their respective PIDs, **datasets *under review* should be published before the article gets published**. Once a manuscript has been accepted, the authors should be informed to publish their dataset *under review*. This ensures that the data has a registered DOI when the article gets published. Consequently, journals can run quality control checks on the provided DOI such as validation. This process must be explicitly communicated with authors through the author guidelines, yet, can also be included within other communication upon acceptance. Contemporaneous, the DOI for the article should be provided so that authors can include this information in their dataset's metadata prior to the publication of the dataset. Finally, the article is published, and its DOI is registered. ### Scholix.org diff --git a/docs/50_data_publication/70_publishing_standards/28_publishing_standards_intro.mdx b/docs/50_data_publication/70_publishing_standards/28_publishing_standards_intro.mdx index 3143eeeb..c59c69bf 100644 --- a/docs/50_data_publication/70_publishing_standards/28_publishing_standards_intro.mdx +++ b/docs/50_data_publication/70_publishing_standards/28_publishing_standards_intro.mdx @@ -7,12 +7,12 @@ id: "publishing_standards_intro" import N4CFeatures from '/src/components/N4CFeatures.js'; :::info Info: -Authors, academic publishers and research data infrastructure and resource providers are the target audiences for these standards. +Authors, academic publishers and research data infrastructure providers are the target audiences for these standards. ::: -On this page we collect a non-exhaustive list of data publication standards, formulated as principles, that have been developed within the NFDI4Chem Publication Standards project. These standards are intended to implement the [FAIR Data Principles](/docs/fair/) with repect to data publication workflows. The main objective of these standards is to improve the quality of metadata and streamline publication workflows, including the manuscript peer-review process with corresponding datasets published in research data repositories. +On these pages we collect a non-exhaustive list of data publishing standards, formulated as principles, that have been developed within the NFDI4Chem Publication Standards project. These standards are intended to implement the [FAIR Data Principles](/docs/fair/) with respect to data publishing workflows. The main objective of these standards is to improve the quality of metadata and streamline publishing workflows, including the manuscript peer-review process with corresponding datasets published in research data repositories. -Click on a button below to get started with with standards for authors, academic publishers and infrastructure providers. These standards will be continously updated. +Click on a button below to get started with standards for authors, academic publishers and infrastructure providers. These standards will be continuously updated. diff --git a/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx b/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx index d81da7a0..5c2f184c 100644 --- a/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx +++ b/docs/50_data_publication/70_publishing_standards/30_publishing_standards_infrastructure.mdx @@ -3,25 +3,25 @@ title: "For Infrastructure Providers" slug: "/publishing_standards_infrastructure" --- -### Metadata Should be Part of a Dataset +### Metadata should be part of a dataset :::tip Standard -*Research data repositories should include the metadata in datasets downloaded by researchers.* +*Research data repositories should include the metadata in datasets downloaded by researchers and exchanged with other resources.* ::: -While researchers upload their data, metadata is attached. For generic, multidisciplinary repositories, additional metadata is provided via a metadata editor. For field-specific repositories, the metadata is extracted from the analytical data files and provided by researchers along their lab workflows, as this is the case for Chemotion ELN. Once data is retrieved from a repository, this metadata should not be lost but should be included in the downloaded package. The minimum to include is the descriptive DataCite metadata. +While researchers upload their data, metadata is attached. For generic, multidisciplinary repositories, additional metadata is provided by researchers via a metadata editor. For field-specific repositories, the metadata is extracted from the analytical data files and provided by researchers along their lab workflows, as this is the case for Chemotion ELN. Once data is retrieved from a repository, this metadata should not be lost but should be included in the downloaded package. The minimum to include is the descriptive DataCite metadata. -[BagIt](https://www.rfc-editor.org/rfc/rfc8493.html), a set of hierarchical file system conventions, is one solution for including metadata in downloaded dataset. +[BagIt](https://www.rfc-editor.org/rfc/rfc8493.html), a set of hierarchical file system conventions, is one solution to enable reliable file transfer and to include metadata in downloaded dataset, as this is already the case for RADAR. -### Structured Domain-Specific Metadata Should be Part of a Dataset +### Structured domain-specific metadata should be part of a dataset :::tip Standard -*Research data repositories should include structured, domain-specific metadata in datasets downloaded by researchers.* +*Research data repositories should include structured, domain-specific metadata in datasets downloaded by researchers and exchanged with other resources.* ::: -Beside of metadata following generic schemes such as DataCite's metadata scheme, domain-specific metadata should be part of each dataset. This metadata should also be provided in datasets downloaded by researchers for reuse. +Beside of metadata following generic schemes such as DataCite's metadata scheme, domain-specific metadata should be part of each dataset. This metadata should also be provided in datasets downloaded by researchers for reuse or exchanged with other resources. -One solution to this is to include Schema.org metadata by [combining RO-Crate and BagIt](https://www.researchobject.org/ro-crate/specification/1.1/appendix/implementation-notes.html#adding-ro-crate-to-bagit). +One solution to this is to include Schema.org metadata making use of [RO-Crate](https://www.researchobject.org/) or by even [combining RO-Crate and BagIt](https://www.researchobject.org/ro-crate/specification/1.1/appendix/implementation-notes.html#adding-ro-crate-to-bagit). While BagIt focusses on reliable transfer, RO-Crate is about rich metadata. ### Collection DOIs @@ -29,9 +29,9 @@ One solution to this is to include Schema.org metadata by [combining RO-Crate an *Research data repositories should provide a Collection DOI to wrap research data objects that are relevant to a single article that is to be published.* ::: -Field-specific research data repositories may provide DOIs to reference individual chemical reactions, molecules, and their analytical data. Generic, multidisciplinary research data repositories provide DOIs for whole published datasets, while more than one published dataset may be relevant to study results published via an article. In other words, many DOIs may be relevant to a published article, whereas **a data availability statement may provide some DOIs but not many DOIs**. To facilitate the process of manuscript submission and article publication, each repository should provide a **Collection DOI** that wraps relevant data that should be referenced in the data availability statement. This will ensure that all data underlying a published manuscript can be linked to an article in the data availability statement and the CrossRef metadata of that article. +Field-specific research data repositories may provide DOIs to reference individual chemical reactions, molecules, and their analytical data. Generic, multidisciplinary research data repositories provide DOIs for whole published datasets, while more than one published dataset may be relevant to study results published via an article. In other words, many DOIs may be relevant to a published article, whereas **a data availability statement may provide some DOIs but not many DOIs**. To facilitate the process of manuscript submission and article publication, each repository should allow authors to generate a **Collection DOI** that wraps relevant data that should be referenced in the data availability statement. -### Embargo Period and Metadata Accessibility +### Embargo period and metadata accessibility :::tip Standard *Datasets published with an embargo period should have inaccessible data but accessible metadata.* @@ -42,26 +42,26 @@ While an **embargo** period restricts access to a published dataset, the **metad ### Scholix.org :::tip Standard -*Research data repositories should contribute to Scholix.org.* +*Research data repositories should contribute and use to Scholix.org.* ::: -[**Scholix**](https://doi.org/10.1045/january2017-burton) provides the framework for improving the links between scientific literature and research data as well as between data and data with the goal of providing a **high-level interoperability framework for exchanging information about these links**. Thus, Scholix hubs, such as [DataCite](https://datacite.org/) or [OpenAire](https://www.openaire.eu/), contribute information on their metadata records, which contain information on connected digital objects. This information is used by academic publishers to discover datasets that correspond to an article but were published after the article was published, which allows the metadata of the article to be updated with links to the dataset. +[**Scholix**](https://doi.org/10.1045/january2017-burton) provides the framework for improving the links between scientific literature and research data as well as between data and data with the goal of providing a **high-level interoperability framework for exchanging information about these links**. Thus, Scholix hubs, such as [DataCite](https://datacite.org/) or [OpenAire](https://www.openaire.eu/), contribute information on their metadata records, which contain information on connected digital objects. This information is used by academic publishers to discover datasets that correspond to an article but were published after the article was published, which allows the metadata of the article to be updated with links to the dataset. Vice versa, repositories should use Scholix.org to find related datasets and articles and to set links to datasets published in their own infrastructure by updating the metadata of such datasets with related identifiers. -### Datasets under Review +### Datasets under review :::tip Standard *Research data repositories should provide access to datasets under review.* ::: -In order to include datasets in the review process of manuscripts, repositories should provide access to reviewers. It is strongly encouraged that repositories provide a status *in review* in addition to the statuses *draft* and *published*. **A dataset under review should not be editable but should be accessible** via a URL, while the DOI is not yet discoverable and the DOI metadata is not yet accessible as the dataset has not yet been published. +In order to include datasets in the review process of manuscripts, repositories should provide access to reviewers. It is strongly encouraged that repositories provide a status *in review* in addition to the statuses *draft* and *published*. **A dataset under review should not be editable but should be accessible** via a URL, while the DOI is not yet discoverable and the DOI metadata is not yet accessible as the dataset has not yet been published. Such datasets *under review* might be assigned with an (internally) reserved DOI. -### Reviewer Access to Datasets under Review +### Reviewer access to datasets under review :::tip Standard *URLs to access datasets under review should have the access credentials encoded within the URL.* ::: -**Review links** for datasets *under review* should have the **access credentials** encoded in the URL, rather than having separate login and password. This avoids having to forward these details to the reviewer via the submission system. +**Review links** for datasets *under review* should have the **access credentials** encoded in the URL, rather than having separate login and password. This avoids the need to send this information to the reviewer via the submission system or letter to the editor, which has already been shown to be an error-prone process. ### Publisher and PublisherIdentifier in DataCite Metadata @@ -88,7 +88,7 @@ In XML: This ensures humans as well as machines can trace and interpret where the data has been published. -### Metadata Corrections and Updates +### Metadata corrections and updates :::tip Standard *Research data repositories should allow researchers to correct and update the metadata of datasets.* @@ -96,7 +96,7 @@ This ensures humans as well as machines can trace and interpret where the data h As the process of adding metadata via a metadata editor can be error-prone, creators should be allowed to **correct and update** the PID metadata as well as any other metadata. For full transparency, metadata may be **versioned**. The record may indicate to viewers that changes were made. Updating metadata contributes to [FAIR](/docs/fair) ([F2](/docs/fair/#f2-data-are-described-with-rich-metadata-defined-by-r1-below)) by enhancing the richness of metadata, and also allows creators to add additional related identifiers for recently published related datasets and articles. -### Legal Issues on Dataset Abstract +### Legal issues on dataset abstracts :::tip Standard *Research data repositories should inform authors and data curators about possible rights conflicts for the abstract field in the datasets DataCite metadata.* @@ -104,7 +104,7 @@ As the process of adding metadata via a metadata editor can be error-prone, crea Dataset's should have their **own description as an abstract**. Copying the related article abstract can result in a **rights conflict** with the respective academic publisher. This is particularly the case in German law. Authors and data curators should be informed of this conflict, e.g. via a **tooltip** when adding metadata using a metadata editor. -### Group Licences +### Group licences :::tip Standard *In research data repositories, licences should be grouped into research data licences and software licences.* @@ -112,7 +112,7 @@ Dataset's should have their **own description as an abstract**. Copying the rela Repositories often tend to provide confusingly long lists of licences. Furthermore, **licences** differ for datasets and software. Providing a **grouping** will greatly assist authors in selecting from the correct set. -### Encourage Creative Commons Licences +### Encourage Creative Commons licences :::tip Standard *Research data repositories should encourage researchers to choose a Creative Commons licence to simplify the landscape of licences and their choice.* @@ -120,7 +120,7 @@ Repositories often tend to provide confusingly long lists of licences. Furthermo In line with grouping licences between software and datasets, pointing authors towards the selection of a [**Creative Commons (CC)**](https://creativecommons.org/) licence alleviates the selection process. When publishing research data, Creative Commons licences that are no more restrictive than CC BY are strongly recommended. -### Promote the least Restrictive Creative Commons Licences +### Promote the least restrictive Creative Commons licences :::tip Standard *Research data repositories should suggest licences such as CC0 or CC BY by pre-selecting such a licence rather than more restrictive licences such as CC BY-SA or even CC BY-NC-ND, which can inhibit reuse.* @@ -128,7 +128,7 @@ In line with grouping licences between software and datasets, pointing authors t Shared data should be as **open as possible, as closed as necessary** with the intent of allowing and enabling others to reuse and build upon the work. Thus, encouraging rather open licences such as **[CC0](https://creativecommons.org/public-domain/cc0/)** and **[CC BY](https://creativecommons.org/licences/by/4.0/)** as opposed to more restrictive licences such as [CC BY-SA](https://creativecommons.org/licences/by-sa/4.0/) or even [CC BY-NC-ND](https://creativecommons.org/licences/by-nc-nd/4.0/). Such restrictive licences can make data reuse difficult. -### Creators and Contributors +### Creators and contributors :::tip Standard *Research data repositories should label fields for creators in their (DataCite) metadata editor as* Authors/Creators.