IQSS / dataverse-client-r

R Client for Dataverse Repositories
https://iqss.github.io/dataverse-client-r
61 stars 24 forks source link

Appropriate server defaults #64

Closed kuriwaki closed 2 years ago

kuriwaki commented 3 years ago

tldr: Help pages and tests should specify a server, either via Sys.setenv("DATAVERSE_SERVER" = "havard.dataverse.edu") OR specifying server = "harvard.dataverse.edu" each time.

Background: The server argument used in most of the functions has the default Sys.getenv("DATAVERSE_SERVER"), which means that the initial user would get a "server not specified" error when trying out the help page examples.

So shouldn't all minimal working examples specify a server argument?

Also this default is inconsistent with the documentation, which says (emphasis mine)

A character string specifying a Dataverse server. There are multiple Dataverse installations, but the defaults is to use the Harvard Dataverse. This can be modified atomically or globally using Sys.setenv("DATAVERSE_SERVER" = "dataverse.example.com").