Skip to content
339 changes: 339 additions & 0 deletions doc/sphinx-guides/source/admin/features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,339 @@
# Features

An overview of Dataverse features can be found at <https://dataverse.org/software-features>. This is a more comprehensive list.

```{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

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

### Versioning

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

### File previews

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

### Preview and analysis of tabular files

Data Explorer allows for searching, charting and cross tabulation analysis
{ref}`More information.<inventory-of-external-tools>`

### Guestbook

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

### File download in R and TSV format

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

### Faceted search

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

## Administration

### Quotas

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

### Usage statistics and metrics

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

### Private URL

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

### Notifications

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

### User management

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

### Curation status labels

Let curators mark datasets with a status label customized to your needs.
{ref}`More information.<:AllowedCurationLabels>`

## Customization

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

### Branding

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

## 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.</installation/localcontexts>`

### 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)
### Prepublication Review Support

Datasets start as drafts and can be submitted for review before publication.
{ref}`More information.<dataverse-permissions>`

## File management

### Retention Periods

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

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

### File hierarchy

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

### Fixity checks for files

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

### Backend storage on S3 or Swift

Choose between filesystem or object storage, configurable per collection and per dataset.
{doc}`More information.</developers/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.</developers/big-data-support>`

### Pull header metadata from Astronomy (FITS) files

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

### 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

### Metadata Extraction from Geospatial Files

Populate the bounding box from NetCDF and HDF5 files.
{ref}`More information.<netcdf-and-hdf5>`

### Geospatial Search API

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

### Geospatial File Preview

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

### Geospatial Metadata Fields

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

## Integrations

### Galaxy Integration

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

### Handles

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

### iRODS

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

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

### 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

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

### GitHub integration

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

### Integration with 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>`

## Interoperability

### Signposting

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

### Harvest from DataCite

Harvest metadata directly from DataCite to Dataverse using OAI-PMH.
{ref}`More information.<harvesting-from-datacite>`

### Croissant

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

### RO-Crate

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

### 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.</admin/harvestclients>`

### APIs for interoperability and custom integrations

Search API, Data Deposit (SWORD) API, Data Access API, Metrics API, Migration API, etc.
{doc}`More information.</api/index>`

### API client libraries

Interact with Dataverse APIs from Python, R, Javascript, Java, and Ruby
{doc}`More information.</api/client-libraries>`

### Schema.org JSON-LD

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

### External vocabulary

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

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

## Reusability

### Data citation for datasets and files

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

### Multiple licenses

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

### Custom terms of use

Custom terms of use can be used in place of a license or disabled by an administrator.
{ref}`More information.<license-terms>`

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

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
Loading