Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create rdm-linking.md #1942

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 62 additions & 0 deletions book/website/reproducible-research/rdm/rdm-linking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
(rr-rdm-linking)=
# Linking your data, code and your publication

## Motivations
Linking your data and article by properly {ref}`citing data <rr-credit-cite-data>` will ensure that you receive credit for your work and it will increase the visibility of your research outputs.

There are several different ways to do this.

You can decide to 1) open up your data publicly, at the same time as for example the **preprint** of your article, or 2) keep the dataset closed until the article is published.

### 1. Open the dataset

The easiest way to connect your dataset to your publication is to publish the dataset first (for example, at the same time as the **preprint**).
This will provide you with the correct information for your {ref}`Data Availability Statement <rr-rdm-data-availability-statement>` and your references, and will allow reviewers to include the dataset in their review.

If any adjustments are needed based on the review process you can often upload a new version of the dataset (see for example [Zenodo](https://zenodo.org/), [Figshare](https://figshare.com/), [4TU.ResearchData](https://data.4tu.nl/info//en/)).

Remember that the contributors and date of deposition are publicly available, making it unlikely that others will 'scoop' you.
But if you are hesitant about opening up your dataset before the article is published, you can either publish the dataset under restricted access, under embargo, or wait with publishing and reserve a DOI.

### 2. Keep the dataset closed

#### Publish your dataset under restricted access
Publishing your data under restricted access means that the data is uploaded to the repository, but you're only providing access to individuals that request access or you can provide access through sharing a private link.
* You decide with whom to share the private link and whether individuals that request access will obtain access.
* You can share the data with reviewers
* Your metadata (information about the data) is publicly available.
* You can provide the correct DOI in the paper's {ref}`Data Availability Statement <rr-rdm-data-availability-statement>` and in the reference list
* After your article is published:
* Add the DOI of the publication to the dataset
* Change the access permission rights to public (see for example Zenodo).


#### Publish your dataset under embargo

An embargo means that you have already uploaded the data to the repository, but are not providing access to the data until a certain date.

* No one has access to your data until the embargo period has expired (you can define this period), or until you changed the access permissions yourself.
* You cannot share the data with reviewers
* Your metadata (information about the data) is publicly available.
* You can provide the correct DOI in the paper's {ref}`Data Availability Statement <rr-rdm-data-availability-statement>` and in the reference list
* After your article is published:
* Add the DOI of the publication to the dataset
* Change the access permission rights if the embargo has not yet expired (see for example Zenodo).

#### Reserve a DOI and publish later

Several data repositories allow you to reserve a DOI (see for example Zenodo, Figshare)

Reserving a DOI means you are not required to upload your data yet, but you will need to provide some metadata (title, author/contributors, date) to complete the DOI reservation.
The reserved DOI will be in use after you actually uploaded the data and decide to publish the data.
* No one has access to your data or the metadata yet, because the landing page of your dataset is not working yet.
* Your data is not available to reviewers.
* You can provide the correct DOI in the paper's {ref}`Data Availability Statement <rr-rdm-data-availability-statement>` and in the reference list
* After your article is published:
* Upload the dataset to your reserved DOI.
* Add the DOI of the publication to the dataset
* Publish your dataset

## Check the data DOI in your publication
Whichever route you decide to take, it is important to double check the proof of your article.
The DOI for your dataset should be correctly listed in the {ref}`Data Availability Statement <rr-rdm-data-availability-statement>` and in the reference list.