Commit b516c97e authored by Cassandra Gould van Praag's avatar Cassandra Gould van Praag
Browse files

added zenodo doi instructions

parent 3b4fce4b
Pipeline #10420 passed with stages
in 1 minute and 56 seconds
...@@ -58,11 +58,16 @@ The benefit of the above comes from version control of the singularity container ...@@ -58,11 +58,16 @@ The benefit of the above comes from version control of the singularity container
External users will be able to access the shared code and singularity containers, along with data when this is shared openly, and repeat the analysis to probe the results. External users will also be able to modify shared analysis code to suit there own needs, where this is shared with a permissive license. External users will be able to access the shared code and singularity containers, along with data when this is shared openly, and repeat the analysis to probe the results. External users will also be able to modify shared analysis code to suit there own needs, where this is shared with a permissive license.
## How to use ## How to use
### Access #### Analysis wrapper
Coming soon Coming soon
{: .label .label-yellow } {: .label .label-yellow }
Detailed guidance on how to use the Open Analysis tools will be produced during one of our [documentation hacks](../events/doc-hack-1.md) Detailed guidance on how to use the Open Analysis wrapper will be produced during one of our [documentation hacks](../events/doc-hack-1.md)
#### Repository template
#### Creating a doi
We recommend using zenodo to create a doi for your material. See see the [creating a doi](analysis/doi.md) page for instructions.
## Working group members (alphabetically) ## Working group members (alphabetically)
We are grateful to the following WIN members for their contributions to developing the Open Analysis tools We are grateful to the following WIN members for their contributions to developing the Open Analysis tools
......
---
layout: default
title: Creating a doi
parent: Open Analysis
grand_parent: Open WIN Tools
has_children: false
nav_order: 1
---
# Creating a doi
{: .fs-9 }
How to create a doi in zenodo for your GitLab project
{: .fs-6 .fw-300 }
---
Zenodo is free to use tool for creating a digital object identifier (doi) for your shared resources. A doi is essential for enabling others researchers to cite and reuse your material, and for you to receive proper attribution. Your doi entry will include your [ORCID ID](https://info.orcid.org/benefits-for-researchers/), so it can be tracked against all your other research outputs.
## First time creating a doi for a GitLab repository
1. In [zenodo](https://zenodo.org), log in or create an account. Go to "[new upload](https://zenodo.org/deposit/new)" and add details about your material. Click the "resave doi" button to get the doi which will be issued by zenodo.
2. Copy this doi into your README for your project on GitLab, or other documentation. Include this in a section entitled "How to cite this material".
3. Make a “[release](https://stackoverflow.com/questions/29520905/how-to-create-releases-in-gitlab)” of the repository. Add a note to mark this as the initial release.
4. Download the repository from GitLab (download icon on the repository home page) as a .zip or other compressed file type.
5. Upload the compressed file collection to zenodo.
6. Finalise the zenodo entry will all contributors including their ORDIC IDs. Include a link to the GitLab repository.
7. Set an embargo period for the material if it is not yet publicly available on GitLab.
## Updating the material
If you make substantial changes to your material, you may want to update the doi record. Changes may include adding new contributors, or new code.
Zenodo allows you to issue a new "version" of your record. All versions will resolve to a single doi, therefore anyone who follows your old doi will see that a new version is available. Read [more about this from zenodo](https://blog.zenodo.org/2017/05/30/doi-versioning-launched/).
To create a new version of your record:
1. Make a “[release](https://stackoverflow.com/questions/29520905/how-to-create-releases-in-gitlab)” of your GitLab repository. Add a note to describe the changes that have been made.
2. Download the repository from GitLab (download icon on the repository home page) as a .zip or other compressed file type.
3. Go to your zenodo entry for the first release. Click the "new version" button and upload the new material. Make any other changes to the record as necessary.
This version updating process can be automated using the [zenodo API](https://developers.zenodo.org). This may be useful if you are making regular (or more complex) changes to your material. The method for doing this will reuse the material created for [funpak](https://git.fmrib.ox.ac.uk/fsl/funpack). Further guidance and a template for usage will be made available shortly.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment