Thank you for contributing your data. The aim of this repository is to make the submission process as easy as possible. In fact, we will do the actual injection in the database for you. Why? There are a few reasons: we know how to do it, we know how to troubleshoot it, you won't feel as bad if you make a mistake, and you have other things to do. Our goal is to make the submission process a "sit back, relax, and enjoy" experience (for the data depositors).
➡️ Go here for instructions about preparing the data (or keep reading for a brief overview of the process)
There are three steps to submitting a dataset (and one of them is only taking a few seconds!). Here is a checklist, and some description of each step below:
- register at https://mangal.io/auth using your ORCID ID
- fill-in the templates, open a Submission Help issue if stuck
- open an issue using the Data Submission model
This is not something you actually have to do. If you have an ORCID ID, all
you need to do is click on https://mangal.io/auth, login with ORCID, and you
will have an account. We will ask for your ORCID during the submission process
if you want it to be linked to the data. At this link (which you can revisit at
any point), you will see a field called access_token - do not share it. Some
of the issues templates will ask for your ID, and by this we mean your ORCID ID.
You should never have to share (or, indeed, use) your access token.
That's it. Welcome to the user list.
This step is probably the longest, and if we're being honnest, it's not 100% mandatory. As of Nov. 2021, we have added about 130k interactions by writing bespoke scripts for each dataset. It's just that it takes longer, and often involves a number of back and forth emails to clarify points of data structure.
To make sure that the data are published as rapidly and efficiently as possible, it is a good idea to attach the templates to your data submission issue (see the next section!). The links to the templates, alongside their documentation, can be found here. If you are stuck with the preparation of the data, you can open an issue and pick the Submission Help model.
The last step is to open an issue and pick the Data Submission model. There will be a few information to provide (most of them are metadata), and someone will be in touch shortly to check the data and start the injection process.
What is the license of the data on mangal.io? CC-0 by default, or the license of the dataset that was previously uploaded to e.g. Dryad, figshare, etc.
How do I know the data will not be uploaded wrong? The data submission script is using a number of sanity checks to make sure the data are injected exactly as provided. Part of this involves using the type system to validate the data before they are sent to the database. Nothing is done without human supervision, and every injection is manually examined after the fact to see if there are issues to address.
Why not use a pull request to publish data? Having spent a lot of time around code, we don't trust code. Manual inspection of data will most likely always be how we proceed.
I found an error in the data! That's not a question but fine; there is a specific type of issue (called Data Issue) you can open on this repository, and we will examine and fix the issue.
I'm really stuck! Again, not a question, but you can open a Submission Help issue; we can either find a solution, or schedule a screen-sharing session to examine how to best format the data.