Skip to content

Commit 3ab7708

Browse files
committed
updates from today's doc meeting #11998
1 parent 8482c7d commit 3ab7708

1 file changed

Lines changed: 98 additions & 84 deletions

File tree

doc/sphinx-guides/source/admin/features.md

Lines changed: 98 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ An overview of Dataverse features can be found at <https://dataverse.org/softwar
77
:depth: 3
88
```
99

10+
## Highlights
11+
12+
- ...
13+
- ...
1014

1115
## AI
1216

@@ -22,85 +26,77 @@ Model Context Protocol (MCP) is a standard for AI Agents to communicate with too
2226

2327
## Access and download
2428

25-
### Login via Shibboleth
26-
27-
Single Sign On (SSO) using your institution's credentials.
28-
{doc}`More information.</installation/shibboleth>`
29-
30-
### Login via ORCID, Google, GitHub, or Microsoft
31-
32-
Log in using popular OAuth2 providers.
33-
{doc}`More information.</installation/oauth2>`
34-
35-
### Login via OpenID Connect (OIDC)
36-
37-
Log in using your institution's identity provider or a third party.
38-
{doc}`More information.</installation/oidc>`
39-
40-
### Versioning
29+
### Faceted search
4130

42-
History of changes to datasets and files are preserved.
43-
{doc}`More information.</user/dataset-management>`
31+
Facets are data driven and customizable per collection.
32+
{doc}`More information.</user/find-use-data>`
4433

4534
### File previews
4635

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

50-
### Preview and analysis of tabular files
39+
### Preview URL
5140

52-
Data Explorer allows for searching, charting and cross tabulation analysis
53-
{ref}`More information.<inventory-of-external-tools>`
41+
Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset.
42+
{ref}`More information.<previewUrl>`
5443

5544
### Guestbook
5645

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

60-
### File download in R and TSV format
49+
### File download in open tabular formats
6150

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

65-
### Faceted search
54+
## Administration
6655

67-
Facets are data driven and customizable per collection.
68-
{doc}`More information.</user/find-use-data>`
56+
### User management
6957

70-
## Administration
58+
Dashboard for common user-related tasks.
59+
{doc}`More information.</admin/dashboard>`
7160

7261
### Quotas
7362

74-
For number of files, etc.
63+
For number of files, amount of storage, etc.
7564
{doc}`More information.</admin/collectionquotas>`
7665

7766
### Usage statistics and metrics
7867

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

82-
### Private URL
71+
### Configurable notifications
8372

84-
Create a URL for reviewers to view an unpublished (and optionally anonymized) dataset.
85-
{ref}`More information.<previewUrl>`
73+
In-app and email notifications for access requests, requests for review, etc. can be muted.
74+
{ref}`More information.<account-notifications>`
8675

87-
### Notifications
76+
## Authentication
8877

89-
In app and email notifications for access requests, requests for review, etc.
90-
{ref}`More information.<account-notifications>`
78+
### Login via Shibboleth
9179

92-
### User management
80+
Single Sign On (SSO) using your institution's credentials.
81+
{doc}`More information.</installation/shibboleth>`
9382

94-
Dashboard for common user-related tasks.
95-
{doc}`More information.</admin/dashboard>`
83+
### Login via ORCID, Google, GitHub, or Microsoft
9684

97-
### Curation status labels
85+
Log in using popular OAuth2 providers.
86+
{doc}`More information.</installation/oauth2>`
9887

99-
Let curators mark datasets with a status label customized to your needs.
100-
{ref}`More information.<:AllowedCurationLabels>`
88+
### Login via OpenID Connect (OIDC)
89+
90+
Log in using your institution's identity provider or a third party.
91+
{doc}`More information.</installation/oidc>`
10192

10293
## Customization
10394

95+
### Branding
96+
97+
Your installation can be branded with a custom homepage, header, footer, CSS, etc.
98+
{ref}`More information.<Branding Your Installation>`
99+
104100
### Internationalization
105101

106102
The Dataverse software has been translated into multiple languages.
@@ -116,33 +112,34 @@ Each personal or organizational collection can be customized and branded.
116112
Embed listings of data in external websites.
117113
{ref}`More information.<dataverse-widgets>`
118114

119-
### Branding
120-
121-
Your installation can be branded with a custom homepage, header, footer, CSS, etc.
122-
{ref}`More information.<Branding Your Installation>`
123-
124115
## FAIR data publication
125116

126-
### TK Labels
127-
128-
Integrate with the Local Contexts platform, enabling the use of Traditional Knowledge and Biocultural Labels, and Notices.
129-
{doc}`More information.</installation/localcontexts>`
130-
131117
### Support for FAIR Data Principles
132118

133119
Findable, Accessible, Interoperable, Reusable.
134120
[More information.](https://web.archive.org/web/20191206043258/https://scholar.harvard.edu/mercecrosas/presentations/fair-guiding-principles-implementation-dataverse)
121+
122+
### Versioning
123+
124+
History of changes to datasets and files are preserved.
125+
{doc}`More information.</user/dataset-management>`
126+
135127
### Prepublication Review Support
136128

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

132+
### TK Labels
133+
134+
Integrate with the Local Contexts platform, enabling the use of Traditional Knowledge and Biocultural Labels, and Notices.
135+
{doc}`More information.</installation/localcontexts>`
136+
140137
## File management
141138

142-
### Retention Periods
139+
### File hierarchy
143140

144-
Make files inaccessible once the retention period set has passed.
145-
{ref}`More information.<retention-periods>`
141+
Users are able to control dataset file hierarchy and directory structure.
142+
{doc}`More information.</user/dataset-management>`
146143

147144
### Restricted files
148145

@@ -154,17 +151,12 @@ Control who can download files and choose whether or not to enable a "Request Ac
154151
Make files inaccessible until an embargo end date.
155152
{ref}`More information.<embargoes>`
156153

157-
### File hierarchy
158-
159-
Users are able to control dataset file hierarchy and directory structure.
160-
{doc}`More information.</user/dataset-management>`
161-
162-
### Fixity checks for files
154+
### Retention Periods
163155

164-
MD5, SHA-1, SHA-256, SHA-512, UNF.
165-
{ref}`More information.<:FileFixityChecksumAlgorithm>`
156+
Make files inaccessible once the retention period set has passed.
157+
{ref}`More information.<retention-periods>`
166158

167-
### Backend storage on S3 or Swift
159+
### Configurable storage
168160

169161
Choose between filesystem or object storage, configurable per collection and per dataset.
170162
{doc}`More information.</developers/big-data-support>`
@@ -174,10 +166,10 @@ Choose between filesystem or object storage, configurable per collection and per
174166
After a permission check, files can pass freely and directly between a client computer and S3.
175167
{doc}`More information.</developers/big-data-support>`
176168

177-
### Pull header metadata from Astronomy (FITS) files
169+
### Fixity checks for files
178170

179-
Dataset metadata prepopulated from FITS file metadata.
180-
{ref}`More information.<fits>`
171+
MD5, SHA-1, SHA-256, SHA-512, UNF.
172+
{ref}`More information.<:FileFixityChecksumAlgorithm>`
181173

182174
### Auxiliary files for data files
183175

@@ -186,6 +178,16 @@ Each data file can have any number of auxiliary files for documentation or other
186178

187179
## Geospatial
188180

181+
### Geospatial Metadata Fields
182+
183+
There is a dedicated geospatial metadata block.
184+
{ref}`More information.<metadata-references>`
185+
186+
### Geospatial File Preview
187+
188+
GeoJSON, GeoTIFF, and Shapefiles can be previewed as a map.
189+
{ref}`More information.<geojson>`
190+
189191
### Metadata Extraction from Geospatial Files
190192

191193
Populate the bounding box from NetCDF and HDF5 files.
@@ -196,17 +198,19 @@ Populate the bounding box from NetCDF and HDF5 files.
196198
Pass `geo_point` and `geo_radius` to find datasets based on their bounding box.
197199
{doc}`More information.</api/search>`
198200

199-
### Geospatial File Preview
201+
## Integrations
200202

201-
GeoJSON, GeoTIFF, and Shapefiles can be previewed as a map.
202-
{ref}`More information.<geojson>`
203+
Dataverse integrates with a wide variety of third party systems, some of which are highlighted below. For a full list, see {doc}`Integrations</admin/integrations>`.
203204

204-
### Geospatial Metadata Fields
205+
### DataCite Integration
205206

206-
There is a dedicated geospatial metadata block.
207-
{ref}`More information.<metadata-references>`
207+
DOIs are reserved, and when datasets are published, their metadata is published to DataCite.
208+
{doc}`More information.</admin/discoverability>`
208209

209-
## Integrations
210+
### External tools
211+
212+
Enable additional features not built in to the Dataverse software.
213+
{doc}`More information.</installation/external-tools>`
210214

211215
### Galaxy Integration
212216

@@ -228,21 +232,11 @@ Upload from and download to Dataverse using Globus endpoints.
228232
Pull data from an iRODS instance to a Dataverse dataset.
229233
{ref}`More information.<irods>`
230234

231-
### DMPTool Integration Via RSpace
235+
### RSpace
232236

233-
A Data Management Plan (DMP) can be uploaded to RSpace and updated with the DOI of a Dataverse dataset.
237+
Exchange data and metadata with RSpace. For example, a Data Management Plan (DMP) can be uploaded to RSpace and updated with the DOI of a Dataverse dataset.
234238
{ref}`More information.<rspace>`
235239

236-
### DataCite integration
237-
238-
DOIs are reserved, and when datasets are published, their metadata is published to DataCite.
239-
{doc}`More information.</admin/discoverability>`
240-
241-
### External tools
242-
243-
Enable additional features not built in to the Dataverse software.
244-
{doc}`More information.</installation/external-tools>`
245-
246240
### Dropbox integration
247241

248242
Upload files stored on Dropbox.
@@ -337,3 +331,23 @@ Allow publication of a dataset to kick off external processes and integrations.
337331
Upload standard W3C provenance files or enter free text instead.
338332
{ref}`More information.<provenance>`
339333

334+
335+
## Misc
336+
337+
### Preview and analysis of tabular files
338+
339+
Data Explorer allows for searching, charting and cross tabulation analysis
340+
{ref}`More information.<inventory-of-external-tools>`
341+
342+
343+
## Curation
344+
345+
### Curation status labels
346+
347+
Let curators mark datasets with a status label customized to your needs.
348+
{ref}`More information.<:AllowedCurationLabels>`
349+
350+
### Pull header metadata from Astronomy (FITS) files
351+
352+
Dataset metadata prepopulated from FITS file metadata.
353+
{ref}`More information.<fits>`

0 commit comments

Comments
 (0)