diff --git a/docs/source/_static/doi_options.png b/docs/source/_static/doi_options.png new file mode 100644 index 0000000..0176515 Binary files /dev/null and b/docs/source/_static/doi_options.png differ diff --git a/docs/source/data_management/citing_and_publishing_datasets.md b/docs/source/data_management/citing_and_publishing_datasets.md index 1c58ed0..a354cb5 100644 --- a/docs/source/data_management/citing_and_publishing_datasets.md +++ b/docs/source/data_management/citing_and_publishing_datasets.md @@ -1,69 +1,118 @@ # 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 +2. **Create a DOI and Landing Page** - Register a persistent identifier that resolves to a landing page with comprehensive dataset information. +3. **Maintain Metadata** - Keep DOI metadata accurate and up to date +4. **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) + +![DataCite_Repository_Guidelines](../_static/repository_obligations_table.png) + ## 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) +- [Data Citation Roadmap (Scholarly Repositories)](https://www.biorxiv.org/content/biorxiv/early/2017/10/09/097196.full.pdf) +- [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. diff --git a/docs/source/data_management/creating_a_doi.md b/docs/source/data_management/creating_a_doi.md deleted file mode 100644 index 3adc6b8..0000000 --- a/docs/source/data_management/creating_a_doi.md +++ /dev/null @@ -1,89 +0,0 @@ -# Creating a DOI via CU Libraries and DataCite - -As of 2018, CU Libraries is a member of DataCite. Through this membership, LASP can mint and -register DOIs for datasets housed in our repositories, enabling data to be persistently identified, -accessed, and cited. - -Guidelines for assigning Digital Object Identifiers (DOIs) to datasets using this -membership, including steps for request, metadata requirements, and long-term -responsibilities are outlined here. - -## Purpose - -This guideline supports LASP’s data publishing workflows by enabling the creation and registration -of persistent identifiers (DOIs) for datasets using CU resources. These identifiers help ensure -long-term access, discoverability, and proper citation of data. - -## How to create a DOI - -Dataset DOIs should resolve to a dataset landing page providing information about the dataset like where it can be -accessed. CU libraries automatically generates a generic landing page populated with high level metadata on datasets -provided in a DOI request form. Whereas CU Scholar, another CU resource, requires data providers to have a reference to -such a landing page when creating a DOI. - -Note, that the number of DOIs allocated to LASP is limited. - -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) - -![DataCite_Repository_Guidelines](../_static/repository_obligations_table.png) - -## Getting Help - -Please use the [DATAMAN](https://jira.lasp.colorado.edu/secure/RapidBoard.jspa?rapidView=1430) project on MODS-Jira to -submit a ticket, and someone from the Data Management Working Group will respond to it. - -## Useful Links - -- [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) -- [Data Citation Roadmap (Scholarly Repositories)](https://www.biorxiv.org/content/biorxiv/early/2017/10/09/097196.full.pdf) -- [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) -- [CU Scholar](https://scholar.colorado.edu/about) -- [Creating a DOI for Software](../workflows/open_source/citing_software.md) - -## Acronyms - -- **DOI** = Digital Object Identifier -- **NASA** = National Aeronautics and Space Administration -- **EOSDIS** = Earth Observing System Data and Information System -- **API** = Application Programming Interface - -Credit: Content taken from a Confluence guide written by Anne Wilson and updated by Doug Lindholm diff --git a/docs/source/data_management/digital_object_identifiers.md b/docs/source/data_management/digital_object_identifiers.md index 5d4c928..a20640c 100644 --- a/docs/source/data_management/digital_object_identifiers.md +++ b/docs/source/data_management/digital_object_identifiers.md @@ -51,7 +51,8 @@ To enable accessibility, a DOI needs to reside in a registry where it can be resolved. The registry collects and provides high level information, assigns DOIs, and links to references. -[DataCite](https://datacite.org/) is a not-for-profit, global +#### [DataCite](https://datacite.org/) +DataCite is a not-for-profit, global initiative to "help the research community locate, identify, and cite research data with confidence," through DOI minting and registration. It is the leading global provider of DOIs @@ -70,14 +71,16 @@ membership, LASP can mint and register DOIs for datasets housed in our repositories, enabling data to be persistently identified, accessed, and cited. -[Crossref](https://www.crossref.org/) is another registry that +#### [Crossref](https://www.crossref.org/) +Crossref is another registry that is often mentioned in Earth and space science contexts. It's a not-for-profit association of ~2000 voting member publishers who represent 4300 societies and publishers. It exists to facilitate the links between distributed content hosted at other sites, and uses DOIs to do so. -[Zenodo](https://zenodo.org/) is a free repository developed +#### [Zenodo](https://zenodo.org/) +Zenodo is a free repository developed by CERN and operated by OpenAIRE. It is a general-purpose repository that allows researchers to deposit datasets, research software, reports, and any other research-related @@ -86,7 +89,8 @@ content, making it citable and discoverable. See [citing software](../workflows/open_source/citing_software.md) for more on using Zenodo to cite software. -[ORCiDs](https://orcid.org/) are like DOIs but provide +#### [ORCiDs](https://orcid.org/) +ORCiDs are like DOIs but provide persistent digital object identifiers for people. ## DOI Format @@ -121,6 +125,15 @@ input form may be integrated into the DOI. Note that DOI names are not case-sensitive, while URLs are case-sensitive: https://support.datacite.org/docs/datacite-doi-display-guidelines. +## Navigating Options at LASP +There are internal and external options available for creating DOIs for various types of products +including datasets, software, and presentations. If you're not +sure where to start, reach out to the LASP Data Management team for guidance by submitting +a Jira issue with type "DOI" in the [Data Management Jira project](https://jira.lasp.colorado.edu/projects/DATAMAN/). + +![DOI_Format](../_static/doi_options.png) + + ## Useful Links - [DataCite: DOI Basics](https://support.datacite.org/docs/doi-basics)