Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
e7ba59b
move the list of features into the guides #11998
pdurbin Nov 22, 2025
0fb5356
group by category #11998
pdurbin Dec 1, 2025
e3d71d1
Merge pull request #12011 from IQSS/11998-features-in-guides-categories
pdurbin Dec 22, 2025
3e2178b
Merge branch 'develop' into 11998-features-in-guides
pdurbin Dec 22, 2025
d91f0b9
Merge branch 'develop' into 11998-features-in-guides
pdurbin Jan 16, 2026
bc23286
crosslink "features" and "what is dataverse" pages #11998
pdurbin Jan 16, 2026
ea9b764
Merge branch 'develop' into 11998-features-in-guides
pdurbin Feb 13, 2026
23ef182
added more features (work in progress) #11998
pdurbin Feb 13, 2026
6632334
add more features, descriptions, and links #11998
pdurbin Feb 13, 2026
b93d1aa
link to more info on RO-Crate #11934 #11998
pdurbin Feb 13, 2026
8482c7d
Merge branch 'develop' into 11998-features-in-guides
pdurbin Mar 27, 2026
3ab7708
updates from today's doc meeting #11998
pdurbin Mar 27, 2026
9a0d5f4
Merge branch 'develop' into 11998-features-in-guides
pdurbin Apr 9, 2026
0b8aa15
update integrations, start interoperability, tweak harvesting #11998
pdurbin Apr 10, 2026
292223a
Merge branch 'develop' into 11998-features-in-guides
pdurbin Jun 12, 2026
62211b4
fix link to big data support
pdurbin Jun 12, 2026
05b5832
various improvements from doc wg meeting #11998
pdurbin Jun 12, 2026
e228655
switch to Title Case #11998
pdurbin Jun 12, 2026
94dcafe
remove unused script #11998
pdurbin Jun 12, 2026
b290214
add release note #11998
pdurbin Jun 12, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/release-notes/11998-features-in-guides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A [list of Dataverse features](https://dataverse-guide--12000.org.readthedocs.build/en/12000/admin/features.html) has been added to the guides. See #11998 and #12000.
319 changes: 319 additions & 0 deletions doc/sphinx-guides/source/admin/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,319 @@
# Features

See {doc}`/quickstart/what-is-dataverse` for {ref}`core-capabilities`.

```{contents} Contents:
:local:
:depth: 3
```

## AI

### AI Tools

A number of AI tools integrate with Dataverse.
{doc}`More information.</ai/index>`

### Model Context Protocol (MCP)

Model Context Protocol (MCP) is a standard for AI Agents to communicate with tools and services.
{ref}`More information.<mcp>`

## Access and Download

### Faceted Search

Facets are data driven and customizable per collection.
{doc}`More information.</user/find-use-data>`

### File Previews

A preview is available for text, tabular, image, audio, video, and geospatial files.
{ref}`More information.<file-previews>`

### Preview URL

Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset.
{ref}`More information.<previewUrl>`

### Guestbook

Optionally collect data about who is downloading the files from your datasets.
{ref}`More information.<dataset-guestbooks>`

### File Download in Open Tabular Formats

Proprietary tabular formats are converted into TSV and RData for download.
{doc}`More information.</user/tabulardataingest/index>`

## Administration

### User Management

Dashboard for common user-related tasks.
{doc}`More information.</admin/dashboard>`

### Quotas

For number of files, amount of storage, etc.
{doc}`More information.</admin/collectionquotas>`

### Usage Statistics and Metrics

Download counters, support for Make Data Count.
{doc}`More information.</admin/make-data-count>`

### Configurable Notifications

In-app and email notifications for access requests, requests for review, etc. can be muted.
{ref}`More information.<account-notifications>`

## Authentication

### Login via Shibboleth

Single Sign On (SSO) using your institution's credentials.
{doc}`More information.</installation/shibboleth>`

### Login via ORCID, Google, GitHub, or Microsoft

Log in using popular OAuth2 providers.
{doc}`More information.</installation/oauth2>`

### Login via OpenID Connect (OIDC)

Log in using your institution's identity provider or a third party.
{doc}`More information.</installation/oidc>`

## Customization

### Branding

Your installation can be branded with a custom homepage, header, footer, CSS, etc.
{ref}`More information.<Branding Your Installation>`

### Internationalization

The Dataverse software has been translated into multiple languages.
{ref}`More information.<i18n>`

### Customization of Collections

Each personal or organizational collection can be customized and branded.
{ref}`More information.<theme>`

### Widgets

Embed listings of data in external websites.
{ref}`More information.<dataverse-widgets>`

## FAIR Data Publication

### Support for FAIR Data Principles

Findable, Accessible, Interoperable, Reusable.
[More information.](https://web.archive.org/web/20191206043258/https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse)

### Versioning

History of changes to datasets and files are preserved.
{doc}`More information.</user/dataset-management>`

### Prepublication Review Support

Datasets start as drafts and can be submitted for review before publication where curators can mark datasets with curation status labels.
{ref}`More information.<dataverse-permissions>`

### TK Labels

Integrate with the Local Contexts platform, enabling the use of Traditional Knowledge and Biocultural Labels, and Notices.
{doc}`More information.</installation/localcontexts>`

## File Management

### File Hierarchy

Users are able to control dataset file hierarchy and directory structure.
{doc}`More information.</user/dataset-management>`

### Restricted Files

Control who can download files and choose whether or not to enable a "Request Access" button.
{ref}`More information.<restricted-files>`

### Embargo

Make files inaccessible until an embargo end date.
{ref}`More information.<embargoes>`

### Retention Periods

Make files inaccessible once the retention period set has passed.
{ref}`More information.<retention-periods>`

### Metadata Extraction from Files

Populate dataset metadata fields from tabular, NetCDF, HDF5, and FITS files.
{ref}`More information.<file-handling>`

### Configurable Storage

Choose between filesystem or object storage, configurable per collection and per dataset.
{doc}`More information.</installation/big-data-support>`

### 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.</installation/big-data-support>`

### Fixity Checks for Files

MD5, SHA-1, SHA-256, SHA-512, UNF.
{ref}`More information.<:FileFixityChecksumAlgorithm>`

### Auxiliary Files for Data Files

Each data file can have any number of auxiliary files for documentation or other purposes (experimental).
{doc}`More information.</developers/aux-file-support>`

## Geospatial

### Geospatial Metadata Fields

There is a dedicated geospatial metadata block.
{ref}`More information.<metadata-references>`

### Geospatial File Preview

GeoJSON, GeoTIFF, and Shapefiles can be previewed as a map.
{ref}`More information.<geojson>`

### Geospatial Search API

Pass `geo_point` and `geo_radius` to find datasets based on their bounding box.
{doc}`More information.</api/search>`

## Integrations

### DataCite

DOIs are reserved, and when datasets are published, their metadata is published to DataCite.
{doc}`More information.</admin/discoverability>`

### Handle

Handles are a Persistent ID (PID) that are an alternative to DOIs.
{ref}`More information.<pids-configuration>`

### Globus

Upload from and download to Dataverse using Globus endpoints.
{ref}`More information.<globus-support>`

### RSpace

Exchange data and metadata with RSpace (e.g. IGSN ID). For example, a Data Management Plan (DMP) can be uploaded to RSpace and updated with the DOI of a Dataverse dataset.
{ref}`More information.<rspace>`

### GitHub

A GitHub Action is available to upload files from GitHub to a dataset.
{doc}`More information.</admin/integrations>`

### iRODS

Pull data from an iRODS instance to a Dataverse dataset.
{ref}`More information.<irods>`

### Dropbox

Upload files stored on Dropbox.
{doc}`More information.</admin/integrations>`

### Jupyter Notebooks

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.<binder>`

### Galaxy

Import files directly from Dataverse into Galaxy as well as publish datasets containing artifacts (Histories, datasets, etc.) from Galaxy to Dataverse.
{ref}`More information.<galaxy-integration>`

### External Tools

Enable additional features not built in to the Dataverse software.
{doc}`More information.</installation/external-tools>`

### Additional Integrations

Dataverse integrates with a wide variety of third party systems, some of which are highlighted above. For a full list, see {doc}`Integrations</admin/integrations>`.

## Interoperability

### APIs

Search API, Data Deposit API, Data Access API, Metrics API, Migration API, etc. and client libraries in various languages.
{doc}`More information.</api/index>`

### OAI-PMH Metadata Harvesting

Serve and harvest metadata to and from other systems (e.g. DataCite, other Dataverse installations, etc.) using standardized metadata formats: Dublin Core, Data Document Initiative (DDI), OpenAIRE, etc.
{doc}`More information.</admin/harvestserver>`

### Schema.org JSON-LD

Used by Google Dataset Search and other services for discoverability.
{ref}`More information.<metadata-export-formats>`

### Croissant

Export metadata as linked data following the Croissant ontology.
{ref}`More information.<croissant-head>`

### Signposting

Enable easier machine access to datasets by adding linkset in a Dataverse header.
{ref}`More information.<discovery-sign-posting>`

### External Vocabulary

Let users pick from external vocabularies (provided via API/SKOSMOS) when filling in metadata.
{ref}`More information.<using-external-vocabulary-services>`

### BagIt Export

For preservation, bags can be sent to the local filesystem, Duracloud, and Google Cloud.
{ref}`More information.<BagIt Export>`

### RO-Crate

Export dataset metadata as an ro-crate.json.
{ref}`More information.<metadata-export-formats>`

## Reusability

### Multiple License Support

Users can select from multiple standard and provided custom licenses.
{ref}`More information.<license-config>`

### Custom Terms of Use

Users can write custom terms of use in place of a predefined license.
{ref}`More information.<license-terms>`

### Data Citation Formats

EndNote XML, RIS, BibTeX, or 1000+ CSL formats at the dataset or file level.
{doc}`More information.</user/find-use-data>`

### Provenance

At the file level, upload standard W3C provenance files or enter free text instead.
{ref}`More information.<provenance>`

### Post-Publication Workflows

Allow publication of a dataset to trigger external processes and integrations.
{doc}`More information.</developers/workflows>`
2 changes: 2 additions & 0 deletions doc/sphinx-guides/source/admin/harvestserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ of such instances.

The email portion of :ref:`systemEmail` will be visible via OAI-PMH (from the "Identify" verb).

Please note that Dataverse can also harvest metadata from other OAI-PMH servers, like :ref:`DataCite <harvesting-from-datacite>`. See :doc:`harvestclients` for details.

How does it work?
-----------------

Expand Down
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/admin/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This guide documents the functionality only available to superusers (such as "da
.. toctree::
:maxdepth: 2

features
dashboard
external-tools
discoverability
Expand Down
13 changes: 13 additions & 0 deletions doc/sphinx-guides/source/admin/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,17 @@ 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
++++++

RSpace is an affordable and secure enterprise grade electronic lab notebook (ELN) for researchers to capture and organize data.

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 <https://www.researchspace.com/blog/dmptool-rspace-eln-dataverse-integration>`_, 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
++++++++++++++++++++++++++++++++++

Expand Down Expand Up @@ -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
+++++

Expand Down Expand Up @@ -152,6 +158,13 @@ Open OnDemand

`Open OnDemand <https://openondemand.org>`_ is a web frontend to High Performance Computing (HPC) resources. Through a system called `OnDemand Loop <https://github.com/IQSS/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 <ood-download>` files from Dataverse.

.. _galaxy-integration:

Galaxy
++++++

Import files directly from Dataverse into `Galaxy <https://galaxyproject.org>`_ 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
--------------------------

Expand Down
3 changes: 2 additions & 1 deletion doc/sphinx-guides/source/quickstart/what-is-dataverse.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Loading