From e7ba59b27bf559d93732acf3d24de34eed2303ec Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Sat, 22 Nov 2025 10:29:43 -0500 Subject: [PATCH 1/6] move the list of features into the guides #11998 --- doc/sphinx-guides/source/admin/features.md | 229 +++++++++++++++++++++ doc/sphinx-guides/source/admin/index.rst | 1 + scripts/issues/11998/tsv2md.py | 55 +++++ 3 files changed, 285 insertions(+) create mode 100644 doc/sphinx-guides/source/admin/features.md create mode 100755 scripts/issues/11998/tsv2md.py diff --git a/doc/sphinx-guides/source/admin/features.md b/doc/sphinx-guides/source/admin/features.md new file mode 100644 index 00000000000..5a80771058b --- /dev/null +++ b/doc/sphinx-guides/source/admin/features.md @@ -0,0 +1,229 @@ +# Features + +An overview of Dataverse features can be found at . This is a more comprehensive list. + +```{contents} Contents: +:local: +:depth: 3 +``` + + +## Support for FAIR Data Principles + +Findable, Accessible, Interoperable, Reusable. +[More information.](https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse) +## Data citation for datasets and files + +EndNote XML, RIS, or BibTeX format at the dataset or file level. +{doc}`More information.` + +## OAI-PMH (Harvesting) + +Gather and expose metadata from and to other systems using standardized metadata formats: Dublin Core, Data Document Initiative (DDI), OpenAIRE, etc. +{doc}`More information.` + +## APIs for interoperability and custom integrations + +Search API, Data Deposit (SWORD) API, Data Access API, Metrics API, Migration API, etc. +{doc}`More information.` + +## API client libraries + +Interact with Dataverse APIs from Python, R, Javascript, Java, and Ruby +{doc}`More information.` + +## DataCite integration + +DOIs are reserved, and when datasets are published, their metadata is published to DataCite. +{doc}`More information.` + +## Login via Shibboleth + +Single Sign On (SSO) using your institution's credentials. +{doc}`More information.` + +## Login via ORCID, Google, GitHub, or Microsoft + +Log in using popular OAuth2 providers. +{doc}`More information.` + +## Login via OpenID Connect (OIDC) + +Log in using your institution's identity provider or a third party. +{doc}`More information.` + +## Internationalization + +The Dataverse software has been translated into multiple languages. +{ref}`More information.` + +## Versioning + +History of changes to datasets and files are preserved. +{doc}`More information.` + +## Restricted files + +Control who can download files and choose whether or not to enable a "Request Access" button. +{ref}`More information.` + +## Embargo + +Make content inaccessible until an embargo end date. +{ref}`More information.` + +## Custom licenses + +CC0 by default but add as many standard licenses as you like or create your own. +{ref}`More information.` + +## Custom terms of use + +Custom terms of use can be used in place of a license or disabled by an administrator. +{ref}`More information.` + +## Publishing workflow support + +Datasets start as drafts and can be submitted for review before publication. +{ref}`More information.` + +## File hierarchy + +Users are able to control dataset file hierarchy and directory structure. +{doc}`More information.` + +## File previews + +A preview is available for text, tabular, image, audio, video, and geospatial files. +{ref}`More information.` + +## Preview and analysis of tabular files + +Data Explorer allows for searching, charting and cross tabulation analysis +{ref}`More information.` + +## Usage statistics and metrics + +Download counters, support for Make Data Count. +{doc}`More information.` + +## Guestbook + +Optionally collect data about who is downloading the files from your datasets. +{ref}`More information.` + +## Fixity checks for files + +MD5, SHA-1, SHA-256, SHA-512, UNF. +{ref}`More information.<:FileFixityChecksumAlgorithm>` + +## File download in R and TSV format + +Proprietary tabular formats are converted into RData and TSV. +{doc}`More information.` + +## Faceted search + +Facets are data driven and customizable per collection. +{doc}`More information.` + +## Customization of collections + +Each personal or organizational collection can be customized and branded. +{ref}`More information.` + +## Private URL + +Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset. +{ref}`More information.` + +## Widgets + +Embed listings of data in external websites. +{ref}`More information.` + +## Notifications + +In app and email notifications for access requests, requests for review, etc. +{ref}`More information.` + +## Schema.org JSON-LD + +Used by Google Dataset Search and other services for discoverability. +{ref}`More information.` + +## External tools + +Enable additional features not built in to the Dataverse software. +{doc}`More information.` + +## External vocabulary + +Let users pick from external vocabularies (provided via API/SKOSMOS) when filling in metadata. +{ref}`More information.` + +## Dropbox integration + +Upload files stored on Dropbox. +{doc}`More information.` + +## GitHub integration + +A GitHub Action is available to upload files from GitHub to a dataset. +{doc}`More information.` + +## Integration with Jupyter notebooks + +Datasets can be opened in Binder to run code in Jupyter notebooks, RStudio, and other computation environments. +{ref}`More information.` + +## User management + +Dashboard for common user-related tasks. +{doc}`More information.` + +## Curation status labels + +Let curators mark datasets with a status label customized to your needs. +{ref}`More information.<:AllowedCurationLabels>` + +## Branding + +Your installation can be branded with a custom homepage, header, footer, CSS, etc. +{ref}`More information.` + +## Backend storage on S3 or Swift + +Choose between filesystem or object storage, configurable per collection and per dataset. +{doc}`More information.` + +## Direct upload and download for S3 + +After a permission check, files can pass freely and directly between a client computer and S3. +{doc}`More information.` + +## Export data in BagIt format + +For preservation, bags can be sent to the local filesystem, Duraclound, and Google Cloud. +{ref}`More information.` + +## Post-publication automation (workflows) + +Allow publication of a dataset to kick off external processes and integrations. +{doc}`More information.` + +## Pull header metadata from Astronomy (FITS) files + +Dataset metadata prepopulated from FITS file metadata. +{ref}`More information.` + +## Provenance + +Upload standard W3C provenance files or enter free text instead. +{ref}`More information.` + +## Auxiliary files for data files + +Each data file can have any number of auxiliary files for documentation or other purposes (experimental). +{doc}`More information.` + diff --git a/doc/sphinx-guides/source/admin/index.rst b/doc/sphinx-guides/source/admin/index.rst index a8a543571a7..c6522475088 100755 --- a/doc/sphinx-guides/source/admin/index.rst +++ b/doc/sphinx-guides/source/admin/index.rst @@ -13,6 +13,7 @@ This guide documents the functionality only available to superusers (such as "da .. toctree:: :maxdepth: 2 + features dashboard external-tools discoverability diff --git a/scripts/issues/11998/tsv2md.py b/scripts/issues/11998/tsv2md.py new file mode 100755 index 00000000000..888cb9b1595 --- /dev/null +++ b/scripts/issues/11998/tsv2md.py @@ -0,0 +1,55 @@ +#!/usr/bin/env python +# +# Download features.tsv like this: +# curl -L "https://docs.google.com/spreadsheets/d/1EIFGAfDfZAboFa3_ShRfgoT6xSDpKohDH2_iCyO5MtA/export?gid=729532473&format=tsv" > features.tsv +# +# The gid above is a specific tab in this spreadsheet: +# https://docs.google.com/spreadsheets/d/1EIFGAfDfZAboFa3_ShRfgoT6xSDpKohDH2_iCyO5MtA/edit?usp=sharing +# +# Here's the README for the spreadsheet: +# https://docs.google.com/document/d/1wqLVoEpnD93Y_wQtA2cQEkAuC0QstC6XVs9XlA7yvbM/edit?usp=sharing +import sys +from optparse import OptionParser +import csv + +parser = OptionParser() +options, args = parser.parse_args() + +if args: + tsv_file = open(args[0]) +else: + tsv_file = sys.stdin + +print("""# Features + +An overview of Dataverse features can be found at . This is a more comprehensive list. + +```{contents} Contents: +:local: +:depth: 3 +``` + +""") + +reader = csv.DictReader(tsv_file, delimiter="\t") +rows = [row for row in reader] +missing = [] +for row in rows: + title = row["Title"] + description = row["Description"] + url = row["URL"] + dtype = row["DocLinkType"] + target = row["DocLinkTarget"] + print("## %s" % title) + print() + print("%s" % description) + if target == 'url': + print("[More information.](%s)" % (url)) + elif target != '': + print("{%s}`More information.<%s>`" % (dtype, target)) + print() + else: + missing.append(url) +tsv_file.close() +for item in missing: + print(item) From 0fb5356a1ab26f280b62a76c2937284b4d6cf04c Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Mon, 1 Dec 2025 10:46:31 -0500 Subject: [PATCH 2/6] group by category #11998 --- doc/sphinx-guides/source/admin/features.md | 264 +++++++++++---------- scripts/issues/11998/tsv2md.py | 37 +-- 2 files changed, 163 insertions(+), 138 deletions(-) diff --git a/doc/sphinx-guides/source/admin/features.md b/doc/sphinx-guides/source/admin/features.md index 5a80771058b..9aa6cafe6c2 100644 --- a/doc/sphinx-guides/source/admin/features.md +++ b/doc/sphinx-guides/source/admin/features.md @@ -8,222 +8,238 @@ An overview of Dataverse features can be found at ` +Single Sign On (SSO) using your institution's credentials. +{doc}`More information.` -## OAI-PMH (Harvesting) +### Login via ORCID, Google, GitHub, or Microsoft -Gather and expose metadata from and to other systems using standardized metadata formats: Dublin Core, Data Document Initiative (DDI), OpenAIRE, etc. -{doc}`More information.` +Log in using popular OAuth2 providers. +{doc}`More information.` -## APIs for interoperability and custom integrations +### Login via OpenID Connect (OIDC) -Search API, Data Deposit (SWORD) API, Data Access API, Metrics API, Migration API, etc. -{doc}`More information.` +Log in using your institution's identity provider or a third party. +{doc}`More information.` -## API client libraries +### Versioning -Interact with Dataverse APIs from Python, R, Javascript, Java, and Ruby -{doc}`More information.` +History of changes to datasets and files are preserved. +{doc}`More information.` -## DataCite integration +### File previews -DOIs are reserved, and when datasets are published, their metadata is published to DataCite. -{doc}`More information.` +A preview is available for text, tabular, image, audio, video, and geospatial files. +{ref}`More information.` -## Login via Shibboleth +### Preview and analysis of tabular files -Single Sign On (SSO) using your institution's credentials. -{doc}`More information.` +Data Explorer allows for searching, charting and cross tabulation analysis +{ref}`More information.` -## Login via ORCID, Google, GitHub, or Microsoft +### Guestbook -Log in using popular OAuth2 providers. -{doc}`More information.` +Optionally collect data about who is downloading the files from your datasets. +{ref}`More information.` -## Login via OpenID Connect (OIDC) +### File download in R and TSV format -Log in using your institution's identity provider or a third party. -{doc}`More information.` +Proprietary tabular formats are converted into RData and TSV. +{doc}`More information.` -## Internationalization +### Faceted search -The Dataverse software has been translated into multiple languages. -{ref}`More information.` +Facets are data driven and customizable per collection. +{doc}`More information.` -## Versioning +## Administration -History of changes to datasets and files are preserved. -{doc}`More information.` +### Usage statistics and metrics -## Restricted files +Download counters, support for Make Data Count. +{doc}`More information.` -Control who can download files and choose whether or not to enable a "Request Access" button. -{ref}`More information.` +### Private URL -## Embargo +Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset. +{ref}`More information.` -Make content inaccessible until an embargo end date. -{ref}`More information.` +### Notifications -## Custom licenses +In app and email notifications for access requests, requests for review, etc. +{ref}`More information.` -CC0 by default but add as many standard licenses as you like or create your own. -{ref}`More information.` +### User management -## Custom terms of use +Dashboard for common user-related tasks. +{doc}`More information.` -Custom terms of use can be used in place of a license or disabled by an administrator. -{ref}`More information.` +### Curation status labels -## Publishing workflow support +Let curators mark datasets with a status label customized to your needs. +{ref}`More information.<:AllowedCurationLabels>` -Datasets start as drafts and can be submitted for review before publication. -{ref}`More information.` +## Customization -## File hierarchy +### Internationalization -Users are able to control dataset file hierarchy and directory structure. -{doc}`More information.` +The Dataverse software has been translated into multiple languages. +{ref}`More information.` -## File previews +### Customization of collections -A preview is available for text, tabular, image, audio, video, and geospatial files. -{ref}`More information.` +Each personal or organizational collection can be customized and branded. +{ref}`More information.` -## Preview and analysis of tabular files +### Widgets -Data Explorer allows for searching, charting and cross tabulation analysis -{ref}`More information.` +Embed listings of data in external websites. +{ref}`More information.` -## Usage statistics and metrics +### Branding -Download counters, support for Make Data Count. -{doc}`More information.` +Your installation can be branded with a custom homepage, header, footer, CSS, etc. +{ref}`More information.` -## Guestbook +## FAIR data publication -Optionally collect data about who is downloading the files from your datasets. -{ref}`More information.` +### Support for FAIR Data Principles -## Fixity checks for files +Findable, Accessible, Interoperable, Reusable. +[More information.](https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse) +### Publishing workflow support -MD5, SHA-1, SHA-256, SHA-512, UNF. -{ref}`More information.<:FileFixityChecksumAlgorithm>` +Datasets start as drafts and can be submitted for review before publication. +{ref}`More information.` -## File download in R and TSV format +## File management -Proprietary tabular formats are converted into RData and TSV. -{doc}`More information.` +### Restricted files -## Faceted search +Control who can download files and choose whether or not to enable a "Request Access" button. +{ref}`More information.` -Facets are data driven and customizable per collection. -{doc}`More information.` +### Embargo -## Customization of collections +Make content inaccessible until an embargo end date. +{ref}`More information.` -Each personal or organizational collection can be customized and branded. -{ref}`More information.` +### File hierarchy -## Private URL +Users are able to control dataset file hierarchy and directory structure. +{doc}`More information.` -Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset. -{ref}`More information.` +### Fixity checks for files -## Widgets +MD5, SHA-1, SHA-256, SHA-512, UNF. +{ref}`More information.<:FileFixityChecksumAlgorithm>` -Embed listings of data in external websites. -{ref}`More information.` +### Backend storage on S3 or Swift -## Notifications +Choose between filesystem or object storage, configurable per collection and per dataset. +{doc}`More information.` -In app and email notifications for access requests, requests for review, etc. -{ref}`More information.` +### Direct upload and download for S3 -## Schema.org JSON-LD +After a permission check, files can pass freely and directly between a client computer and S3. +{doc}`More information.` -Used by Google Dataset Search and other services for discoverability. -{ref}`More information.` +### Pull header metadata from Astronomy (FITS) files -## External tools +Dataset metadata prepopulated from FITS file metadata. +{ref}`More information.` -Enable additional features not built in to the Dataverse software. -{doc}`More information.` +### Auxiliary files for data files -## External vocabulary +Each data file can have any number of auxiliary files for documentation or other purposes (experimental). +{doc}`More information.` -Let users pick from external vocabularies (provided via API/SKOSMOS) when filling in metadata. -{ref}`More information.` +## Integrations + +### DataCite integration + +DOIs are reserved, and when datasets are published, their metadata is published to DataCite. +{doc}`More information.` + +### External tools + +Enable additional features not built in to the Dataverse software. +{doc}`More information.` -## Dropbox integration +### Dropbox integration Upload files stored on Dropbox. {doc}`More information.` -## GitHub integration +### GitHub integration A GitHub Action is available to upload files from GitHub to a dataset. {doc}`More information.` -## Integration with Jupyter notebooks +### Integration with Jupyter notebooks Datasets can be opened in Binder to run code in Jupyter notebooks, RStudio, and other computation environments. {ref}`More information.` -## User management +## Interoperability -Dashboard for common user-related tasks. -{doc}`More information.` +### OAI-PMH (Harvesting) -## Curation status labels +Gather and expose metadata from and to other systems using standardized metadata formats: Dublin Core, Data Document Initiative (DDI), OpenAIRE, etc. +{doc}`More information.` -Let curators mark datasets with a status label customized to your needs. -{ref}`More information.<:AllowedCurationLabels>` +### APIs for interoperability and custom integrations -## Branding +Search API, Data Deposit (SWORD) API, Data Access API, Metrics API, Migration API, etc. +{doc}`More information.` -Your installation can be branded with a custom homepage, header, footer, CSS, etc. -{ref}`More information.` +### API client libraries -## Backend storage on S3 or Swift +Interact with Dataverse APIs from Python, R, Javascript, Java, and Ruby +{doc}`More information.` -Choose between filesystem or object storage, configurable per collection and per dataset. -{doc}`More information.` +### Schema.org JSON-LD + +Used by Google Dataset Search and other services for discoverability. +{ref}`More information.` -## Direct upload and download for S3 +### External vocabulary -After a permission check, files can pass freely and directly between a client computer and S3. -{doc}`More information.` +Let users pick from external vocabularies (provided via API/SKOSMOS) when filling in metadata. +{ref}`More information.` -## Export data in BagIt format +### Export data in BagIt format For preservation, bags can be sent to the local filesystem, Duraclound, and Google Cloud. {ref}`More information.` -## Post-publication automation (workflows) +## Reusability -Allow publication of a dataset to kick off external processes and integrations. -{doc}`More information.` +### Data citation for datasets and files -## Pull header metadata from Astronomy (FITS) files +EndNote XML, RIS, or BibTeX format at the dataset or file level. +{doc}`More information.` -Dataset metadata prepopulated from FITS file metadata. -{ref}`More information.` +### Custom licenses -## Provenance +CC0 by default but add as many standard licenses as you like or create your own. +{ref}`More information.` -Upload standard W3C provenance files or enter free text instead. -{ref}`More information.` +### Custom terms of use -## Auxiliary files for data files +Custom terms of use can be used in place of a license or disabled by an administrator. +{ref}`More information.` -Each data file can have any number of auxiliary files for documentation or other purposes (experimental). -{doc}`More information.` +### Post-publication automation (workflows) + +Allow publication of a dataset to kick off external processes and integrations. +{doc}`More information.` + +### Provenance + +Upload standard W3C provenance files or enter free text instead. +{ref}`More information.` diff --git a/scripts/issues/11998/tsv2md.py b/scripts/issues/11998/tsv2md.py index 888cb9b1595..47c65e51f6c 100755 --- a/scripts/issues/11998/tsv2md.py +++ b/scripts/issues/11998/tsv2md.py @@ -11,6 +11,7 @@ import sys from optparse import OptionParser import csv +from itertools import groupby parser = OptionParser() options, args = parser.parse_args() @@ -34,22 +35,30 @@ reader = csv.DictReader(tsv_file, delimiter="\t") rows = [row for row in reader] missing = [] -for row in rows: - title = row["Title"] - description = row["Description"] - url = row["URL"] - dtype = row["DocLinkType"] - target = row["DocLinkTarget"] - print("## %s" % title) +# Sort rows by category +rows.sort(key=lambda x: x["Categories"]) + +# Group by category +for category, group in groupby(rows, key=lambda x: x["Categories"]): + # print('BEGIN') + print("## %s" % category) print() - print("%s" % description) - if target == 'url': - print("[More information.](%s)" % (url)) - elif target != '': - print("{%s}`More information.<%s>`" % (dtype, target)) + for row in group: + title = row["Title"] + description = row["Description"] + url = row["URL"] + dtype = row["DocLinkType"] + target = row["DocLinkTarget"] + print("### %s" % title) print() - else: - missing.append(url) + print("%s" % description) + if target == 'url': + print("[More information.](%s)" % (url)) + elif target != '': + print("{%s}`More information.<%s>`" % (dtype, target)) + print() + else: + missing.append(url) tsv_file.close() for item in missing: print(item) From bc232862b8190905662cb26721b06d639caf85f8 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 16 Jan 2026 09:20:26 -0500 Subject: [PATCH 3/6] crosslink "features" and "what is dataverse" pages #11998 --- doc/sphinx-guides/source/admin/features.md | 2 +- doc/sphinx-guides/source/quickstart/what-is-dataverse.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/sphinx-guides/source/admin/features.md b/doc/sphinx-guides/source/admin/features.md index 9aa6cafe6c2..59bf7e85fa5 100644 --- a/doc/sphinx-guides/source/admin/features.md +++ b/doc/sphinx-guides/source/admin/features.md @@ -1,6 +1,6 @@ # Features -An overview of Dataverse features can be found at . This is a more comprehensive list. +An overview of Dataverse features can be found at {ref}`core-capabilities` and . This is a more comprehensive list. ```{contents} Contents: :local: diff --git a/doc/sphinx-guides/source/quickstart/what-is-dataverse.md b/doc/sphinx-guides/source/quickstart/what-is-dataverse.md index 6f86473bada..ceb3da0a6ad 100644 --- a/doc/sphinx-guides/source/quickstart/what-is-dataverse.md +++ b/doc/sphinx-guides/source/quickstart/what-is-dataverse.md @@ -10,6 +10,7 @@ A Dataverse repository can host one or more Dataverse collections, which organiz - Data files - Documentation or code +(core-capabilities)= ## Core Capabilities ### 📤 Upload, manage, publish and download data files. @@ -37,4 +38,4 @@ A Dataverse repository can host one or more Dataverse collections, which organiz - Compare versions with the detailed version change overview on dataset-level. ### ✨More features -The Dataverse project is continuously evolving. For an overview of capabilities, visit the [features list](https://dataverse.org/software-features). +The Dataverse project is continuously evolving. For an overview of capabilities, see {doc}`/admin/features` in the Admin Guide. From 23ef182a2fe4fe113191b03fab2a5c8968ec8851 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 13 Feb 2026 11:02:15 -0500 Subject: [PATCH 4/6] added more features (work in progress) #11998 --- doc/sphinx-guides/source/admin/features.md | 96 +++++++++++++++++-- .../source/admin/integrations.rst | 7 ++ .../source/user/dataset-management.rst | 2 + 3 files changed, 99 insertions(+), 6 deletions(-) diff --git a/doc/sphinx-guides/source/admin/features.md b/doc/sphinx-guides/source/admin/features.md index 59bf7e85fa5..032709dac89 100644 --- a/doc/sphinx-guides/source/admin/features.md +++ b/doc/sphinx-guides/source/admin/features.md @@ -1,6 +1,6 @@ # Features -An overview of Dataverse features can be found at {ref}`core-capabilities` and . This is a more comprehensive list. +An overview of Dataverse features can be found at . This is a more comprehensive list. ```{contents} Contents: :local: @@ -8,6 +8,13 @@ An overview of Dataverse features can be found at {ref}`core-capabilities` and < ``` +## AI + +### Model Context Protocol (MCP) + + +{ref}`More information.` + ## Access and download ### Login via Shibboleth @@ -57,6 +64,9 @@ Facets are data driven and customizable per collection. ## Administration +### Quotas + +For number of files, etc. ### Usage statistics and metrics Download counters, support for Make Data Count. @@ -106,17 +116,27 @@ Your installation can be branded with a custom homepage, header, footer, CSS, et ## FAIR data publication +### TK Labels + +Integrate with the Local Contexts platform, enabling the use of Traditional Knowledge and Biocultural Labels, and Notices. +{doc}`More information.` + ### Support for FAIR Data Principles Findable, Accessible, Interoperable, Reusable. [More information.](https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse) -### Publishing workflow support +### Prepublication Review Support Datasets start as drafts and can be submitted for review before publication. {ref}`More information.` ## File management +### Retention Periods + +Make files inaccessible once the retention period set has passed. +{ref}`More information.` + ### Restricted files Control who can download files and choose whether or not to enable a "Request Access" button. @@ -124,7 +144,7 @@ Control who can download files and choose whether or not to enable a "Request Ac ### Embargo -Make content inaccessible until an embargo end date. +Make files inaccessible until an embargo end date. {ref}`More information.` ### File hierarchy @@ -157,8 +177,47 @@ Dataset metadata prepopulated from FITS file metadata. Each data file can have any number of auxiliary files for documentation or other purposes (experimental). {doc}`More information.` +## Geospatial + +### Metadata Extraction from Geospatial Files + +Populate the bounding box from NetCDF and HDF5 files. +{ref}`More information.` + +### Geospatial Search API + +Pass `geo_point` and `geo_radius` to find datasets based on their bounding box. +{doc}`More information.` + +### Geospatial File Preview + +GeoJSON, GeoTIFF, and Shapefiles can be previewed as a map. +{ref}`More information.` + +### Geospatial Metadata Fields + +There is a dedicated geospatial metadata block. +{ref}`More information.` + ## Integrations +### Galaxy Integration + + +{ref}`More information.` + +### Handles + + +### Globus + +Upload from and download to Dataverse using Globus endpoints. +### iRODS + +Pull data from an iRODS instance to a Dataverse dataset. +### DMPTool Integration Via RSpace + + ### DataCite integration DOIs are reserved, and when datasets are published, their metadata is published to DataCite. @@ -181,11 +240,31 @@ A GitHub Action is available to upload files from GitHub to a dataset. ### Integration with Jupyter notebooks -Datasets can be opened in Binder to run code in Jupyter notebooks, RStudio, and other computation environments. +Datasets can be opened in Binder to run code in Jupyter notebooks, RStudio, and other computation environments. They can also be previewed in Dataverse itself. {ref}`More information.` ## Interoperability +### Signposting + +Enable easier machine access to datasets by adding linkset in a Dataverse header. +{ref}`More information.` + +### Harvest from DataCite + +Harvest metadata directly from DataCite to Dataverse using OAI-PMH. +{ref}`More information.` + +### Croissant + +Export metadata as linked data following the Croissant ontology. +{ref}`More information.` + +### RO-Crate + +Export dataset metadata as an ro-crate.json. +{ref}`More information.` + ### OAI-PMH (Harvesting) Gather and expose metadata from and to other systems using standardized metadata formats: Dublin Core, Data Document Initiative (DDI), OpenAIRE, etc. @@ -220,10 +299,10 @@ For preservation, bags can be sent to the local filesystem, Duraclound, and Goog ### Data citation for datasets and files -EndNote XML, RIS, or BibTeX format at the dataset or file level. +EndNote XML, RIS, BibTeX, or 1000+ CSL formats at the dataset or file level. {doc}`More information.` -### Custom licenses +### Multiple licenses CC0 by default but add as many standard licenses as you like or create your own. {ref}`More information.` @@ -243,3 +322,8 @@ Allow publication of a dataset to kick off external processes and integrations. Upload standard W3C provenance files or enter free text instead. {ref}`More information.` +https://guides.dataverse.org/en/latest/admin/collectionquotas.html +https://guides.dataverse.org/en/latest/installation/config.html#persistent-identifiers-and-publishing-datasets +https://guides.dataverse.org/en/latest/admin/integrations.html#globus +https://guides.dataverse.org/en/latest/admin/integrations.html#irods + diff --git a/doc/sphinx-guides/source/admin/integrations.rst b/doc/sphinx-guides/source/admin/integrations.rst index bb981c75ace..238ba564380 100644 --- a/doc/sphinx-guides/source/admin/integrations.rst +++ b/doc/sphinx-guides/source/admin/integrations.rst @@ -152,6 +152,13 @@ Open OnDemand `Open OnDemand `_ is a web frontend to High Performance Computing (HPC) resources. Through a system called `OnDemand Loop `_, developed at IQSS, researchers can create datasets in Dataverse and upload files to them from their Open OnDemand installation. They can also :ref:`download ` files from Dataverse. +.. _galaxy2: + +Galaxy +++++++ + +Import files directly from Dataverse into `Galaxy `_ as well as publish datasets containing artifacts (Histories, datasets, etc.) from Galaxy to Dataverse. For details, see https://github.com/galaxyproject/galaxy/pull/19367 + Embedding Data on Websites -------------------------- diff --git a/doc/sphinx-guides/source/user/dataset-management.rst b/doc/sphinx-guides/source/user/dataset-management.rst index 22e72a6a210..90b8bcebd9a 100755 --- a/doc/sphinx-guides/source/user/dataset-management.rst +++ b/doc/sphinx-guides/source/user/dataset-management.rst @@ -763,6 +763,8 @@ Once a dataset with embargoed files has been published, no further action is nee As the primary use case of embargoes is to make the existence of data known now, with a promise (to a journal, project team, etc.) that the data itself will become available at a given future date, users cannot change an embargo once a dataset version is published. Dataverse instance administrators do have the ability to correct mistakes and make changes if/when circumstances warrant. +.. _retention-periods: + Retention Periods ================= From 6632334b3278b88495f889140a9461f750b45457 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 13 Feb 2026 14:33:33 -0500 Subject: [PATCH 5/6] add more features, descriptions, and links #11998 --- doc/sphinx-guides/source/admin/features.md | 28 +++++++++++++------ .../source/admin/integrations.rst | 8 +++++- 2 files changed, 26 insertions(+), 10 deletions(-) diff --git a/doc/sphinx-guides/source/admin/features.md b/doc/sphinx-guides/source/admin/features.md index 032709dac89..54f721c3280 100644 --- a/doc/sphinx-guides/source/admin/features.md +++ b/doc/sphinx-guides/source/admin/features.md @@ -10,9 +10,14 @@ An overview of Dataverse features can be found at ` +### Model Context Protocol (MCP) +Model Context Protocol (MCP) is a standard for AI Agents to communicate with tools and services. {ref}`More information.` ## Access and download @@ -67,6 +72,8 @@ Facets are data driven and customizable per collection. ### Quotas For number of files, etc. +{doc}`More information.` + ### Usage statistics and metrics Download counters, support for Make Data Count. @@ -124,7 +131,7 @@ Integrate with the Local Contexts platform, enabling the use of Traditional Know ### Support for FAIR Data Principles Findable, Accessible, Interoperable, Reusable. -[More information.](https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse) +[More information.](https://web.archive.org/web/20191206043258/https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse) ### Prepublication Review Support Datasets start as drafts and can be submitted for review before publication. @@ -203,20 +210,28 @@ There is a dedicated geospatial metadata block. ### Galaxy Integration - -{ref}`More information.` +Import files directly from Dataverse into Galaxy as well as publish datasets containing artifacts (Histories, datasets, etc.) from Galaxy to Dataverse. +{ref}`More information.` ### Handles +Handles are a Persistent ID (PID) that are an alternative to DOIs. +{ref}`More information.` ### Globus Upload from and download to Dataverse using Globus endpoints. +{ref}`More information.` + ### iRODS Pull data from an iRODS instance to a Dataverse dataset. +{ref}`More information.` + ### DMPTool Integration Via RSpace +A Data Management Plan (DMP) can be uploaded to RSpace and updated with the DOI of a Dataverse dataset. +{ref}`More information.` ### DataCite integration @@ -322,8 +337,3 @@ Allow publication of a dataset to kick off external processes and integrations. Upload standard W3C provenance files or enter free text instead. {ref}`More information.` -https://guides.dataverse.org/en/latest/admin/collectionquotas.html -https://guides.dataverse.org/en/latest/installation/config.html#persistent-identifiers-and-publishing-datasets -https://guides.dataverse.org/en/latest/admin/integrations.html#globus -https://guides.dataverse.org/en/latest/admin/integrations.html#irods - diff --git a/doc/sphinx-guides/source/admin/integrations.rst b/doc/sphinx-guides/source/admin/integrations.rst index 238ba564380..65afdce1e56 100644 --- a/doc/sphinx-guides/source/admin/integrations.rst +++ b/doc/sphinx-guides/source/admin/integrations.rst @@ -38,6 +38,8 @@ Researcher can configure OSF itself to deposit to your Dataverse installation by In addition to the method mentioned above, the :ref:`integrations-dashboard` also enables a pull of data from OSF to a dataset. +.. _rspace: + RSpace ++++++ @@ -45,6 +47,8 @@ RSpace is an affordable and secure enterprise grade electronic lab notebook (ELN For instructions on depositing data from RSpace to your Dataverse installation, your researchers can visit https://www.researchspace.com/help-and-support-resources/dataverse-integration/ +As shown in a `video `_, a Data Management Plan (DPM) can be added into RSpace and the research records and associated data can then be sent to Dataverse. Dataverse generates a Persistent Identifier (PID, often a DOI) for the dataset, and RSpace automatically puts the PID link under "Research Outputs" in the DPM. + Open Journal Systems (OJS) and OPS ++++++++++++++++++++++++++++++++++ @@ -86,6 +90,8 @@ GitLab is an open source Git repository and platform that provides free open and The :ref:`integrations-dashboard` enables a pull of data from GitLab to a dataset in Dataverse. +.. _irods: + iRODS +++++ @@ -152,7 +158,7 @@ Open OnDemand `Open OnDemand `_ is a web frontend to High Performance Computing (HPC) resources. Through a system called `OnDemand Loop `_, developed at IQSS, researchers can create datasets in Dataverse and upload files to them from their Open OnDemand installation. They can also :ref:`download ` files from Dataverse. -.. _galaxy2: +.. _galaxy-integration: Galaxy ++++++ From b93d1aab7b8f1d876ffa95ac5749aa0f6e4a9cf2 Mon Sep 17 00:00:00 2001 From: Philip Durbin Date: Fri, 13 Feb 2026 14:51:28 -0500 Subject: [PATCH 6/6] link to more info on RO-Crate #11934 #11998 --- doc/sphinx-guides/source/admin/features.md | 2 +- doc/sphinx-guides/source/user/dataset-management.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/sphinx-guides/source/admin/features.md b/doc/sphinx-guides/source/admin/features.md index 54f721c3280..d485d5f58f5 100644 --- a/doc/sphinx-guides/source/admin/features.md +++ b/doc/sphinx-guides/source/admin/features.md @@ -278,7 +278,7 @@ Export metadata as linked data following the Croissant ontology. ### RO-Crate Export dataset metadata as an ro-crate.json. -{ref}`More information.` +{ref}`More information.` ### OAI-PMH (Harvesting) diff --git a/doc/sphinx-guides/source/user/dataset-management.rst b/doc/sphinx-guides/source/user/dataset-management.rst index 90b8bcebd9a..7b71a8ac66b 100755 --- a/doc/sphinx-guides/source/user/dataset-management.rst +++ b/doc/sphinx-guides/source/user/dataset-management.rst @@ -40,7 +40,7 @@ Once a dataset has been published, its metadata can be exported in a variety of Additional formats can be enabled. See :ref:`inventory-of-external-exporters` in the Installation Guide. To highlight a few: - Croissant -- RO-Crate +- RO-Crate: See also https://www.researchobject.org/ro-crate/dataverse Each of these metadata exports contains the metadata of the most recently published version of the dataset.