service_document function

SWORD Service Document

Obtain a SWORD service document.

service_document(
  key = Sys.getenv("DATAVERSE_KEY"),
  server = Sys.getenv("DATAVERSE_SERVER"),
  ...
)

Arguments

• key: A character string specifying a Dataverse server API key. If one is not specified, functions calling authenticated API endpoints will fail. Keys can be specified atomically or globally using Sys.setenv("DATAVERSE_KEY" = "examplekey").

• server: A character string specifying a Dataverse server. Multiple Dataverse installations exist, with "dataverse.harvard.edu" being the most major. The server can be defined each time within a function, or it can be set as a default via an environment variable. To set a default, run Sys.setenv("DATAVERSE_SERVER" = "dataverse.harvard.edu")

  or add DATAVERSE_SERVER = "dataverse.harvard.edu in one's .Renviron

  file (usethis::edit_r_environ()), with the appropriate domain as its value.

• ...: Additional arguments passed to an HTTP request function, such as GET, POST, or DELETE.

Returns

A list of class sword_service_document , possibly with one or more sword_collection entries. The latter are SWORD representations of a Dataverse. These can be passed to other SWORD API functions, e.g., for creating a new dataset.

Details

This function can be used to check authentication against the Dataverse SWORD server. It is typically a first step when creating a new Dataverse, a new Dataset, or modifying an existing Dataverse or Dataset.

Examples

## Not run:

# retrieve your service document
d <- service_document()

# list available datasets in first dataverse
list_datasets(d[[2]])
## End(Not run)

See Also

Managing a Dataverse: publish_dataverse; Managing a dataset: dataset_atom, list_datasets, create_dataset, delete_dataset, publish_dataset; Managing files within a dataset: add_file, delete_file