Requesting DOIs and ARKs
CyVerse Curated Data in the Data Commons contains files that have been assigned a permanent identifier (DOI or ARK). These files are secure, stable, and unchangeable, thus making them the ideal platform for ease of data reuse and data citation. Datasets in the CyVerse Curated Data site can store very large datasets that are difficult to transfer, upload, and download across different computers and platforms. CyVerse Curated data is accessible to CyVerse's suite of large-scale computational analysis resources, allowing users to seamlessly analyze, manage, and publish new results.
If you are interested in obtaining a permanent identifier for one or more datasets, please read the Permanent Identifier FAQs and then answer the questions on the page, Is Data Commons Curated Data right for my data?
Requesting a DOI
Step 1: Before you begin, review the related pages
Step 2: Organize the dataset in the CyVerse Data Store
There are several steps to properly organizing your dataset. These include determining what data to include, how many identifiers to request, how to organize the data into folders, and creating the ReadMe file and data inventory.
Step 2.1. Determine what to include
A data collection may be composed of multiple files and different datasets. In preparing your data for publication:
- Identify the data and other materials that you consider useful for validation and reuse of your research:
- Data associated to a research project may include multiple files with different roles.
- If there are components of your dataset that belong in a public repository such as NCBI (e.g., fastq files), submit them to the repository, rather than to CyVerse Curated Data.
- Beyond data, you will include the ReadMe file (see Step 4), and you may include scripts or links to scripts to run your analysis.
Step 2.2. Determine how many permanent identifiers to request
To determine how many DOIs to request for a given data collection, consider the following:
- Think about its size and components.
- How many studies or publications does it represent?
- Is your data collection formed by different datasets and are those likely to be used separately?
- Do you want to create a data collection with one DOI for the entire project and additional related DOIs for distinct datasets so that they are cited individually?
If you are uncertain about how many DOIs to request, contact us at.
Step 2.3. Organize your data into folder(s)
- Organize your data so that there is one folder for each DOI (see CyVerse Curated Data folder-naming guidelines for naming conventions).
- Within a folder, include all files in your data package plus the ReadMe file and the inventory.
- You may have subfolders within a data package.
- You may include compressed files in a package, as described on the Permanent Identifier FAQs, but do not compress the entire folder/package.
Step 2.4. Create a ReadMe file
Create a text file labeled "readMe" with the following information:
- How you obtained, organized, and labeled your dataset.
- How to reuse the data, such as which apps can analyze the data.
- The inventory (see step 2.5) may be included as part of the readme file.
- Examples of good readme files:
Step 2.5. Create an inventory
2.7 Supporting documents on data management and organization
Here is a useful guide to data organization: Research Data Management: File Organization (PDF).
Step 3: Add metadata to your folder
- In the Data window, click the checkbox next to the folder.
- Select Metadata > Edit / View Metadata
- Click on + Select Template and and choose the DOI Request / Datacite metadata template.
- Complete the required fields (marked with an asterisk) and as many of the optional fields as possible.
- Save the template. For more information, see Using Metadata in the DE.
- You may add any additional metadata that is appropriate. We encourage the use of additional metadata to make your data better understood and more discoverable.
Step 4: Submit the request for the DOI
- In the Data window, click the checkbox next to the folder.
Select Metadata > Request DOI.
After verifying you have read the manual (this page), click I need a DOI. You will receive a verification email that your request has been received and a notification will be listed in the Notifications list in the DE.
Step 5: Wait for CyVerse validation checks
After submitting your request, a CyVerse Curated Data curator begins validating your dataset, metadata, and overall configuration of your dataset. Validations are based solely on the required DOI metadata and folder-naming conventions, as well as its potential utility to the CyVerse and larger scientific community—not the quality of your data.
- If the curator determines that the dataset is adequately organized and the DataCite metadata are accurate, they will provide a DOI, and you will be notified of the DOI and the location of its corresponding landing page in the Community Data > commons_repo > curated folder in the DE.
- If the curator determines that minor changes are needed, they may make those changes themselves.
- If the curator determines that substantive changes are needed, they will contact you with required changes.
- If the curator determines that your dataset is not appropriate for the Curated Data site, you will be notified.
To check the status of your request, click at the top right of the DE screen. For more information on using notifications in the DE, see Viewing and Deleting Notifications.
Requesting an ARK
The process for issuing ARKs is not yet automated, but if you need one or more ARKs, please contact us at.
Getting your dataset noticed
Metadata, the description about your data, is key to getting your dataset noticed in the world wide web. Search engines and bibliographic aggregators index the metadata that you create to obtain a DOI. Thus, it is important that you do the following:
- Make sure the metadata is complete.
- Include descriptive terms about the science and themes involved in your research. These can go in the "Subject" attribute, but you can also create additional metadata specific to your dataset.
- Include methods used to generate the dataset in the "Description" attribute, and in more detail in a Readme file.
- Include terms such as precise keywords in the "Subject" attribute.
- Describe the dataset for a broader audience so that they understand your research.
- If you or team members have an ORCID ID, make sure to include it when you edit the authors' names.
Publicizing your dataset
There are several ways to publicize your dataset:
- Consider using social media to share the DOI of your dataset, and tag CyVerse.
- If you have an interesting story about your data, contact us at , and we may be able to share it through CyVerse outreach.
- If you have a tool or workflow you developed to analyze your data in CyVerse, consider presenting it as part of our Focus Forums webinars series.