Skip to content

move the list of features into the guides (group by category) #12011

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.

Sign up for GitHub

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

Merged
pdurbin merged 1 commit into from
Dec 22, 2025
+163 −138
Merged

move the list of features into the guides (group by category) #12011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
264 changes: 140 additions & 124 deletions doc/sphinx-guides/source/admin/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,222 +8,238 @@ An overview of Dataverse features can be found at <https://dataverse.org/softwar
```


## Support for FAIR Data Principles
## Access and download

Findable, Accessible, Interoperable, Reusable.
[More information.](https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse)
## Data citation for datasets and files
### Login via Shibboleth

EndNote XML, RIS, or BibTeX format at the dataset or file level.
{doc}`More information.</user/find-use-data>`
Single Sign On (SSO) using your institution's credentials.
{doc}`More information.</installation/shibboleth>`

## 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.</admin/harvestclients>`
Log in using popular OAuth2 providers.
{doc}`More information.</installation/oauth2>`

## 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.</api/index>`
Log in using your institution's identity provider or a third party.
{doc}`More information.</installation/oidc>`

## API client libraries
### Versioning

Interact with Dataverse APIs from Python, R, Javascript, Java, and Ruby
{doc}`More information.</api/client-libraries>`
History of changes to datasets and files are preserved.
{doc}`More information.</user/dataset-management>`

## DataCite integration
### File previews

DOIs are reserved, and when datasets are published, their metadata is published to DataCite.
{doc}`More information.</admin/discoverability>`
A preview is available for text, tabular, image, audio, video, and geospatial files.
{ref}`More information.<file-previews>`

## Login via Shibboleth
### Preview and analysis of tabular files

Single Sign On (SSO) using your institution's credentials.
{doc}`More information.</installation/shibboleth>`
Data Explorer allows for searching, charting and cross tabulation analysis
{ref}`More information.<inventory-of-external-tools>`

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

Log in using popular OAuth2 providers.
{doc}`More information.</installation/oauth2>`
Optionally collect data about who is downloading the files from your datasets.
{ref}`More information.<dataset-guestbooks>`

## 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.</installation/oidc>`
Proprietary tabular formats are converted into RData and TSV.
{doc}`More information.</user/tabulardataingest/index>`

## Internationalization
### Faceted search

The Dataverse software has been translated into multiple languages.
{ref}`More information.<i18n>`
Facets are data driven and customizable per collection.
{doc}`More information.</user/find-use-data>`

## Versioning
## Administration

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

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

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

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

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

## Custom licenses
In app and email notifications for access requests, requests for review, etc.
{ref}`More information.<account-notifications>`

CC0 by default but add as many standard licenses as you like or create your own.
{ref}`More information.<license-config>`
### User management

## Custom terms of use
Dashboard for common user-related tasks.
{doc}`More information.</admin/dashboard>`

Custom terms of use can be used in place of a license or disabled by an administrator.
{ref}`More information.<license-terms>`
### 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.<dataverse-permissions>`
## Customization

## File hierarchy
### Internationalization

Users are able to control dataset file hierarchy and directory structure.
{doc}`More information.</user/dataset-management>`
The Dataverse software has been translated into multiple languages.
{ref}`More information.<i18n>`

## File previews
### Customization of collections

A preview is available for text, tabular, image, audio, video, and geospatial files.
{ref}`More information.<file-previews>`
Each personal or organizational collection can be customized and branded.
{ref}`More information.<theme>`

## Preview and analysis of tabular files
### Widgets

Data Explorer allows for searching, charting and cross tabulation analysis
{ref}`More information.<inventory-of-external-tools>`
Embed listings of data in external websites.
{ref}`More information.<dataverse-widgets>`

## Usage statistics and metrics
### Branding

Download counters, support for Make Data Count.
{doc}`More information.</admin/make-data-count>`
Your installation can be branded with a custom homepage, header, footer, CSS, etc.
{ref}`More information.<Branding Your Installation>`

## Guestbook
## FAIR data publication

Optionally collect data about who is downloading the files from your datasets.
{ref}`More information.<dataset-guestbooks>`
### 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.<dataverse-permissions>`

## File download in R and TSV format
## File management

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

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

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

## Customization of collections
Make content inaccessible until an embargo end date.
{ref}`More information.<embargoes>`

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

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

Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset.
{ref}`More information.<previewUrl>`
### 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.<dataverse-widgets>`
### Backend storage on S3 or Swift

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

In app and email notifications for access requests, requests for review, etc.
{ref}`More information.<account-notifications>`
### 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.</developers/big-data-support>`

Used by Google Dataset Search and other services for discoverability.
{ref}`More information.<metadata-export-formats>`
### Pull header metadata from Astronomy (FITS) files

## External tools
Dataset metadata prepopulated from FITS file metadata.
{ref}`More information.<fits>`

Enable additional features not built in to the Dataverse software.
{doc}`More information.</installation/external-tools>`
### 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.</developers/aux-file-support>`

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

### DataCite integration

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

### External tools

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

## Dropbox integration
### Dropbox integration

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

## GitHub integration
### GitHub integration

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

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

## User management
## Interoperability

Dashboard for common user-related tasks.
{doc}`More information.</admin/dashboard>`
### 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.</admin/harvestclients>`

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.</api/index>`

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

## Backend storage on S3 or Swift
Interact with Dataverse APIs from Python, R, Javascript, Java, and Ruby
{doc}`More information.</api/client-libraries>`

Choose between filesystem or object storage, configurable per collection and per dataset.
{doc}`More information.</developers/big-data-support>`
### Schema.org JSON-LD

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

## 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.</developers/big-data-support>`
Let users pick from external vocabularies (provided via API/SKOSMOS) when filling in metadata.
{ref}`More information.<using-external-vocabulary-services>`

## 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.<BagIt Export>`

## Post-publication automation (workflows)
## Reusability

Allow publication of a dataset to kick off external processes and integrations.
{doc}`More information.</developers/workflows>`
### 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.</user/find-use-data>`

Dataset metadata prepopulated from FITS file metadata.
{ref}`More information.<fits>`
### Custom licenses

## Provenance
CC0 by default but add as many standard licenses as you like or create your own.
{ref}`More information.<license-config>`

Upload standard W3C provenance files or enter free text instead.
{ref}`More information.<provenance>`
### 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.<license-terms>`

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

Allow publication of a dataset to kick off external processes and integrations.
{doc}`More information.</developers/workflows>`

### Provenance

Upload standard W3C provenance files or enter free text instead.
{ref}`More information.<provenance>`

Loading