Skip to content

Commit

Permalink
Merge pull request #385 from NFDI4Chem/pub-standards-collection
Browse files Browse the repository at this point in the history
Pub standards collection
  • Loading branch information
jliermann authored Jul 23, 2024
2 parents 2f394ed + 1a83914 commit bab1527
Show file tree
Hide file tree
Showing 10 changed files with 465 additions and 144 deletions.
28 changes: 17 additions & 11 deletions docs/50_data_publication/00_data_publishing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: "/data_publishing"
id: "data_publishing"
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import useBaseUrl from "@docusaurus/useBaseUrl";

# Data Publishing

Expand All @@ -14,17 +14,22 @@ This page applies to all researchers who want to publish their data.

## Motivation

In chemical research, we strive to share results with others, commonly through articles in renowned scientific journals. To be able to actually work with and build upon these results, the scientific community also requires the data that the results were based on.
In chemical research, we strive to share results with others, commonly through articles in renowned scientific journals. To be able to actually work with and build upon these results, the scientific community also requires the data that the results were based on.

Publishing and therefore sharing these chemistry research data in a [FAIR](/docs/fair) manner by considering aspects such as [persistent identifiers](/docs/pid/), rich [metadata](/docs/metadata), [provenance information](/docs/provenance/), [data formats standards](/docs/format_standards) for analytical data, information on the [license](/docs/licenses/) applied, and by providing [machine-readable chemical structures](/docs/machine-readable_chemical_structures) adds value to the research results and enables discovery and reuse.
Publishing and therefore sharing these chemistry research data in a [FAIR](/docs/fair) manner by considering aspects such as [persistent identifiers](/docs/pid/), rich [metadata](/docs/metadata), [provenance information](/docs/provenance/), [data formats standards](/docs/format_standards) for analytical data, information on the [license](/docs/licenses/) applied, and by providing [machine-readable chemical structures](/docs/machine-readable_chemical_structures) adds value to the research results and enables discovery and reuse.

To publish data is essential to ensure that findings are transparent and reproducible. Moreover, it prevents duplicate efforts to generate data, hence, data publishing is also a measure of sustainability.

## Benefits of data publishing

There are direct benefits for researchers who publish their data. Data publications increase your career recognition, enable new collaborations, and provide a citation advantage compared to articles without an associated and linked dataset in a research data repository.

<img align="center" src={useBaseUrl('/img/data_pub/data_publication_brian_hole_CC_BY_40.png')} alt="Data Publication Brian Hole CC BY 4.0" width="80%" />
<img
align="center"
src={useBaseUrl("/img/data_pub/data_publication_brian_hole_CC_BY_40.png")}
alt="Data Publication Brian Hole CC BY 4.0"
width="80%"
/>

(Source: Brian Hole, [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/), [Slideshare](https://www.slideshare.net/brianhole/the-journal-of-open-archaeology-data-and-prime-incentivising-open-data-archiving))

Expand All @@ -34,8 +39,8 @@ Additionally, the research community benefits here as, for example, new research

There are two main ways to publish research data:

- publish data in a [research data repository](/docs/repositories/)
- publish a separate [data article](/docs/data_articles/) with the corresponding dataset published in a [research data repository](/docs/repositories/)
- publish data in a [research data repository](/docs/repositories/)
- publish a separate [data article](/docs/data_articles/) with the corresponding dataset published in a [research data repository](/docs/repositories/)

:::info Info:
Field-specific repositories should be the first choice as these repositories enhance the FAIRness of data on behalf of the submitters. To retain the same level of FAIRness, data publishing in generic repositories requires manual FAIRification.
Expand All @@ -53,10 +58,11 @@ Still confused about how to publish chemistry data? We do provide a consulting a

## Sources and further information

- [The citation advantage of linking publications to research data](https://doi.org/10.1371/journal.pone.0230416)
- [NSF Public Access Plan 2.0](https://nsf-gov-resources.nsf.gov/2023-06/NSF23104.pdf)
- [DFG Code of Conduct, Guideline 13: Providing public access to research results](https://wissenschaftliche-integritaet.de/en/code-of-conduct/providing-public-access-to-research-results/)
- [How does Open Science practice differ between research disciplines?](https://theplosblog.plos.org/2023/07/open-science-by-discipline/)
- [The citation advantage of linking publications to research data](https://doi.org/10.1371/journal.pone.0230416)
- [NSF Public Access Plan 2.0](https://nsf-gov-resources.nsf.gov/2023-06/NSF23104.pdf)
- [DFG Code of Conduct, Guideline 13: Providing public access to research results](https://wissenschaftliche-integritaet.de/en/code-of-conduct/providing-public-access-to-research-results/)
- [How does Open Science practice differ between research disciplines?](https://theplosblog.plos.org/2023/07/open-science-by-discipline/)

---

----
Main authors: [ORCID:0000-0002-6243-2840](https://orcid.org/0000-0002-6243-2840) and [ORCID:0000-0003-4480-8661](https://orcid.org/0000-0003-4480-8661)
35 changes: 0 additions & 35 deletions docs/50_data_publication/70_publication_standards.mdx

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: "For Authors"
slug: "/publishing_standards_authors"
---

### 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.

### 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


:::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).*
:::

For corresponding data, i.e. directly underlying the results reported in the article, add the PID to the article's [data availability statement](/docs/data_availability_statement), or a similarly termed section. In order to specifically reference and cite your data within the text, add your dataset to the references as well.

:::danger Notice:
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


:::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.*
:::

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

:::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.*
:::

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

:::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.

### Usage of Collection DOIs

:::tip Standard
*Researchers should use the Collection DOI provided by a repository in the data availability statements of their corresponding manuscript to wrap research data objects that are relevant to that of an article 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 a 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, researchers should add the **Collection DOI** provided by the repository to 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.

If individual reactions, molecules, or analytical data should be referenced, add the DOIs of these individual research objects to the reference section and cite within the text accordingly.

<!--Standard on how to publish NMR data, tbd-->

----
Main authors: [ORCID:0000-0003-4480-8661](https://orcid.org/0000-0003-4480-8661), [ORCID: 0000-0002-6243-2840](https://orcid.org/0000-0002-6243-2840)
Loading

0 comments on commit bab1527

Please sign in to comment.