-
Notifications
You must be signed in to change notification settings - Fork 7
Update doi and dataset citation pages #71
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
Open
vmartinez-cu
wants to merge
6
commits into
lasp:main
Choose a base branch
from
vmartinez-cu:update-doi
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
2b0938f
Update this guide to more clearly outline options for creating DOIs a…
vmartinez-cu 755b264
Add graphic for DOI creation options
vmartinez-cu 7ec60ac
Update dataset citation guide to be more comprehensive and include LA…
vmartinez-cu 70daabc
Remove file since content was merged in with citation guide
vmartinez-cu 1737b86
Minor update to section header
vmartinez-cu a1b237e
Fix minor issues identified in PR
vmartinez-cu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
110 changes: 79 additions & 31 deletions
110
docs/source/data_management/citing_and_publishing_datasets.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,117 @@ | ||
| # Publishing and Citing Datasets | ||
|
|
||
| Guidelines for making datasets publicly available, creating DOIs, and properly citing datasets. | ||
|
|
||
| ## Purpose | ||
|
|
||
| This guideline supports Data Systems workflows by ensuring datasets referenced in publications are | ||
| openly accessible, properly identified with DOIs, and cited according to community standards. It | ||
| aligns with publisher and funder policies and promotes scientific reproducibility. | ||
|
|
||
| ## How to Publish and Cite Datasets | ||
|
|
||
| **Make Data Open and Accessible** | ||
| Ensure datasets associated with publications are stored in publicly accessible, machine-readable formats. | ||
| ## Dataset Publishing and Citation Workflow | ||
| The process of publishing and citing datasets involves several key steps: | ||
|
|
||
| **Create a DOI and Landing Page** | ||
| Digital Object Identifiers, DOIs, are machine-readable identifiers that resolve to information about a resource. | ||
| In addition to datasets, researchers can have an ORCID digital identifier, see https://orcid.org/. Publishers are | ||
| now generally requiring DOIs that point to data referenced publications, and often ORCIDs as well. | ||
| - See [Digital Object Identifiers](digital_object_identifiers.md) for an introduction to DOIs. | ||
| - See [Creating a DOI via CU Libraries and DataCite](creating_a_doi.md) for a quick start on creating a DOI and a | ||
| landing page for a dataset. | ||
| - LASP could build resources to create and manage DOIs and associated landing pages. | ||
|
|
||
| **Cite Datasets in Publications** | ||
| Follow established data citation principles to ensure datasets are properly cited in scholarly works. Reference | ||
| 1. **Understand Publisher Requirements** - [DOIs](digital_object_identifiers.md) and [ORCIDs](https://orcid.org/) may be required by publishers to maintain compliance with submission guidelines | ||
| 2. **Make Data Open and Accessible** - Store datasets in publicly accessible, machine-readable formats | ||
| 3. **Create a DOI and Landing Page** - Register a persistent identifier that resolves to a landing page with comprehensive dataset information. | ||
| 4. **Maintain Metadata** - Keep DOI metadata accurate and up to date | ||
| 5. **Cite Datasets Properly** - Follow established data citation principles in publications. Reference | ||
| the [Force 11 Joint Declaration of Data Citation Principles](https://www.force11.org/datacitationprinciples) and | ||
| follow practices described in the [ESIP Dataset Citation Guidelines](https://doi.org/10.6084/m9.figshare.8441816). | ||
|
|
||
| **Understand Publisher Requirements** | ||
| Ensure that DOIs and ORCIDs are included as required by publishers to maintain compliance with submission guidelines. | ||
|
|
||
| ## Options | ||
| ## Publishing Options: | ||
|
|
||
| There are several options for publishing datasets: | ||
| 1. **LASP Data Management Group** | ||
| This group can assist with minting a DOI for LASP hosted datasets and provide guidance on navigating CU resources | ||
| available for data publishing and archiving needs (some described below). | ||
|
|
||
| 1. **CU Libraries and DataCite DOI Creation** | ||
| 2. **CU Libraries** | ||
| Researchers can create DOIs and landing pages for datasets using CU Libraries' integration with DataCite. | ||
|
|
||
| 2. **CU Scholar Hosting** | ||
| 3. **CU Scholar** | ||
| CU Scholar can host articles, reports, and datasets of limited size. CU Scholar prefers to generate and manage DOIs | ||
| for hosted datasets. | ||
| for hosted datasets. They also require data providers to have a reference to a landing page for the DOI to point to. | ||
|
|
||
| 4. **CU Center for Research Data and Digital Scholarship (CRDDS)** | ||
| CRDDS provides guidance and services to assist researchers with making their scholarship (e.g., data sets, journals, | ||
| articles, preprints/postprints, etc.) available to a broader audience. | ||
|
|
||
| 3. **LASP DOI Management (Future Direction)** | ||
| 5. **External Repositories** | ||
| For larger datasets or specialized data types, external repositories that support DOI assignment can be considered. | ||
|
|
||
| 6. **LASP DOI Management (Future Direction)** | ||
| LASP can develop internal resources for creating and managing DOIs and dataset landing pages, streamlining the | ||
| process for LASP-affiliated data products. | ||
|
|
||
| 4. **External Repositories** | ||
| For larger datasets or specialized data types, external repositories that support DOI assignment can be considered. | ||
| ## Quick Start Guide | ||
| As of 2018, CU Libraries is a member of DataCite. Through this membership, LASP can mint and | ||
| register a limited number of DOIs for datasets housed in our repositories, enabling data to be persistently identified, | ||
| accessed, and cited. For LASP-affiliated datasets, researchers can work with the LASP Data Management team | ||
| to create DOIs and get advice on CU resources available to support publishing datasets. | ||
|
|
||
| 1. **Submit a Request** | ||
| - Researchers: File a Jira issue with type "DOI" in the [Data Management Jira project](https://jira.lasp.colorado.edu/projects/DATAMAN/). | ||
|
|
||
| 2. **Prepare Required Metadata** | ||
| - Work with the Data Management team to ensure proper metadata and landing page are available. | ||
| - Minimum required metadata for DOI creation: | ||
| - URL of the landing page (not the dataset itself) | ||
| - Creators (list of names) | ||
| - Title | ||
| - Publisher (typically LASP or a project within LASP) | ||
| - ResourceType (usually `dataset`) | ||
| - DataCite supports additional metadata. Those properties are described here: https://support.datacite.org/docs/metadata-quality. | ||
|
|
||
| 3. **Create DOI via DataCite** | ||
| - Data Management team logs into [doi.datacite.org](https://doi.datacite.org/) using the `CUB.LASP` repository ID. | ||
| - Click "DOIs" → "Create DOI (Form)" | ||
| - Use the form to enter metadata. See full field descriptions at: [DataCite Field Descriptions](https://support.datacite.org/docs/field-descriptions-for-form) | ||
| - For developers: There is an [API](https://support.datacite.org/docs/api) that reads the full metadata schema. | ||
|
|
||
| 4. **Maintain DOI Metadata** | ||
| - Keep DOI metadata up to date in the [DataCite Metadata Store](https://support.datacite.org/docs) | ||
| - If a dataset is moved, update the registry. | ||
| - If a dataset is removed, maintain a “tombstone” landing page. | ||
|
|
||
| 5. **Follow DOI Best Practices** | ||
| - Use landing pages (not direct links to datasets). | ||
| - Maintain metadata quality and completeness as information changes. | ||
| - See [Metadata Guidelines](metadata.md) for dataset metadata requirements. | ||
|
|
||
| 6. **Adhere to Roles and Responsibilities** | ||
| LASP (as a DataCite Client) must meet responsibilities outlined in: | ||
| - [DataCite Community Responsibility](https://support.datacite.org/docs/community-responsibility) | ||
| - [Data Citation Roadmap for Scholarly Data Repositories](https://www.biorxiv.org/content/biorxiv/early/2017/10/09/097196.full.pdf) | ||
|
|
||
|  | ||
vmartinez-cu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Useful Links | ||
|
|
||
| - [Creating a DOI via CU Libraries and DataCite](creating_a_doi.md) | ||
| - [CU Scholar](https://scholar.colorado.edu/about) | ||
| - [CU Center for Research Data and Digital Scholarship (CRDDS)](https://www.colorado.edu/crdds/what-we-do/open-research-publishing) | ||
| - [CU Peta Library](https://www.colorado.edu/petalibrary/) | ||
| - [Force 11 Joint Declaration of Data Citation Principles](https://www.force11.org/datacitationprinciples) | ||
| - [ESIP Dataset Citation Guidelines](https://doi.org/10.6084/m9.figshare.8441816) | ||
| - [Zenodo DOI Citation Guide](https://doi.org/10.5281/zenodo.1451971) | ||
| - [Data Citation Roadmap (Scholarly Repositories)](https://www.biorxiv.org/content/biorxiv/early/2017/10/09/097196.full.pdf) | ||
| - [ORCID](https://orcid.org/) | ||
| - [Intro to Digital Object Identifiers](digital_object_identifiers.md) | ||
| - [DataCite](https://doi.datacite.org/) | ||
| - [Field Descriptions for DOI Form](https://support.datacite.org/docs/field-descriptions-for-form) | ||
| - [DataCite Metadata Quality](https://support.datacite.org/docs/metadata-quality) | ||
| - [DataCite Community Responsibility](https://support.datacite.org/docs/community-responsibility) | ||
| - [Intro to DataCite REST API](https://support.datacite.org/docs/api) | ||
| - [Metadata Requirements](metadata.md) | ||
| - [NASA EOSDIS DOI Guidelines](https://wiki.earthdata.nasa.gov/display/DOIsforEOSDIS) | ||
| - [Creating a DOI for Software](../workflows/open_source/citing_software.md) | ||
| - [DOIs for SORCE Data Products](https://confluence.lasp.colorado.edu/pages/viewpage.action?pageId=21464459) | ||
| (Confluence) | ||
|
|
||
| ## Acronyms | ||
|
|
||
| - **API** = Application Programming Interface | ||
| - **CRDDS** = Center for Research Data and Digital Scholarship | ||
| - **DOI** = Digital Object Identifier | ||
| - **NASA** = National Aeronautics and Space Administration | ||
| - **ORCID** = Open Researcher and Contributor ID | ||
| - **ESIP** = Earth Science Information Partners | ||
|
|
||
| Credit: Content taken from a Confluence guide written by Anne Wilson and Shawn Polson. | ||
| Credit: Content adapted from Confluence guides written by Anne Wilson, Shawn Polson and Doug Lindholm. | ||
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.