Skip to content

Commit 1c5d6e8

Browse files
committed
Dataverse moved to v5 in late 2020. All our new tests are tested against 5 so we can claim to cover that? (cc @wibeasley)
1 parent c9025d7 commit 1c5d6e8

File tree

3 files changed

+16
-17
lines changed

3 files changed

+16
-17
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Suggests:
5353
testthat,
5454
UNF,
5555
yaml
56-
Description: Provides access to Dataverse version 4 APIs <https://dataverse.org/>,
56+
Description: Provides access to Dataverse APIs <https://dataverse.org/> (versions 4-5),
5757
enabling data search, retrieval, and deposit. For Dataverse versions <= 3.0,
5858
use the archived 'dvn' package <https://cran.r-project.org/package=dvn>.
5959
License: GPL-2

README.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "R Client for Dataverse 4 Repositories"
2+
title: "R Client for Dataverse Repositories"
33
output: github_document
44
---
55

@@ -13,7 +13,7 @@ Sys.setenv("DATAVERSE_SERVER" = "dataverse.harvard.edu")
1313

1414
[![Dataverse Project logo](https://dataverse.org/files/dataverseorg/files/dataverse_project_logo-hp.png)](https://dataverse.org)
1515

16-
The **dataverse** package provides access to [Dataverse 4](https://dataverse.org/) APIs, enabling data search, retrieval, and deposit, thus allowing R users to integrate public data sharing into the reproducible research workflow. **dataverse** is the next-generation iteration of [the **dvn** package](https://cran.r-project.org/package=dvn), which works with Dataverse 3 ("Dataverse Network") applications. **dataverse** includes numerous improvements for data search, retrieval, and deposit, including use of the (currently in development) **sword** package for data deposit and the **UNF** package for data fingerprinting.
16+
The **dataverse** package provides access to [Dataverse](https://dataverse.org/) APIs (versions 4-5), enabling data search, retrieval, and deposit, thus allowing R users to integrate public data sharing into the reproducible research workflow. **dataverse** is the next-generation iteration of [the **dvn** package](https://cran.r-project.org/package=dvn), which works with Dataverse 3 ("Dataverse Network") applications. **dataverse** includes numerous improvements for data search, retrieval, and deposit, including use of the (currently in development) **sword** package for data deposit and the **UNF** package for data fingerprinting.
1717

1818
### Getting Started
1919

@@ -32,7 +32,7 @@ library("dataverse")
3232

3333
#### Keys
3434

35-
Some features of the Dataverse 4 API are public and require no authentication. This means in many cases you can search for and retrieve data without a Dataverse account for that a specific Dataverse installation. But, other features require a Dataverse account for the specific server installation of the Dataverse software, and an API key linked to that account. Instructions for obtaining an account and setting up an API key are available in the [Dataverse User Guide](https://guides.dataverse.org/en/latest/user/account.html). (Note: if your key is compromised, it can be regenerated to preserve security.) Once you have an API key, this should be stored as an environment variable called `DATAVERSE_KEY`. It can be set within R using:
35+
Some features of the Dataverse API are public and require no authentication. This means in many cases you can search for and retrieve data without a Dataverse account for that a specific Dataverse installation. But, other features require a Dataverse account for the specific server installation of the Dataverse software, and an API key linked to that account. Instructions for obtaining an account and setting up an API key are available in the [Dataverse User Guide](https://guides.dataverse.org/en/latest/user/account.html). (Note: if your key is compromised, it can be regenerated to preserve security.) Once you have an API key, this should be stored as an environment variable called `DATAVERSE_KEY`. It can be set within R using:
3636

3737
``` r
3838
Sys.setenv("DATAVERSE_KEY" = "examplekey12345")

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
R Client for Dataverse 4 Repositories
1+
R Client for Dataverse Repositories
22
================
33

44
[![CRAN
@@ -12,10 +12,10 @@ Status](https://travis-ci.org/IQSS/dataverse-client-r.png?branch=master)](https:
1212
logo](https://dataverse.org/files/dataverseorg/files/dataverse_project_logo-hp.png)](https://dataverse.org)
1313

1414
The **dataverse** package provides access to
15-
[Dataverse 4](https://dataverse.org/) APIs, enabling data search,
16-
retrieval, and deposit, thus allowing R users to integrate public data
17-
sharing into the reproducible research workflow. **dataverse** is the
18-
next-generation iteration of [the **dvn**
15+
[Dataverse](https://dataverse.org/) APIs (versions 4-5), enabling data
16+
search, retrieval, and deposit, thus allowing R users to integrate
17+
public data sharing into the reproducible research workflow.
18+
**dataverse** is the next-generation iteration of [the **dvn**
1919
package](https://cran.r-project.org/package=dvn), which works with
2020
Dataverse 3 (“Dataverse Network”) applications. **dataverse** includes
2121
numerous improvements for data search, retrieval, and deposit, including
@@ -34,7 +34,7 @@ library("dataverse")
3434

3535
#### Keys
3636

37-
Some features of the Dataverse 4 API are public and require no
37+
Some features of the Dataverse API are public and require no
3838
authentication. This means in many cases you can search for and retrieve
3939
data without a Dataverse account for that a specific Dataverse
4040
installation. But, other features require a Dataverse account for the
@@ -257,13 +257,12 @@ subsequent pages, specify `start`.
257257

258258
### Data Archiving
259259

260-
Dataverse provides two - basically unrelated - workflows for managing
261-
(adding, documenting, and publishing) datasets. The first is built on
262-
[SWORD v2.0](http://swordapp.org/sword-v2/). This means that to create a
263-
new dataset listing, you will have to first initialize a dataset entry with
264-
some metadata, add one or more files to the dataset, and then publish
265-
it. This looks something like the following:
266-
260+
Dataverse provides two - basically unrelated - workflows for managing
261+
(adding, documenting, and publishing) datasets. The first is built on
262+
[SWORD v2.0](http://swordapp.org/sword-v2/). This means that to create a
263+
new dataset listing, you will have to first initialize a dataset entry
264+
with some metadata, add one or more files to the dataset, and then
265+
publish it. This looks something like the following:
267266

268267
``` r
269268
# retrieve your service document

0 commit comments

Comments
 (0)