dataverse (version 0.3.0)

get_dataverse: Get Dataverse

Description

Retrieve details of a Dataverse

Usage

get_dataverse(
  dataverse,
  key = Sys.getenv("DATAVERSE_KEY"),
  server = Sys.getenv("DATAVERSE_SERVER"),
  check = TRUE,
  ...
)
dataverse_contents(
  dataverse,
  key = Sys.getenv("DATAVERSE_KEY"),
  server = Sys.getenv("DATAVERSE_SERVER"),
  ...
)

Arguments

dataverse

A character string specifying a Dataverse name or an object of class “dataverse”.

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. There are multiple Dataverse installations, but the defaults is to use the Harvard Dataverse (server = "dataverse.harvard.edu"). This can be modified atomically or globally using Sys.setenv("DATAVERSE_SERVER" = "dataverse.example.com").

check

A logical indicating whether to check that the value of dataverse is actually a numeric

...

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

Value

A list of class “dataverse”.

Details

get_dataverse function retrieves basic information about a Dataverse from a Dataverse server. To see the contents of the Dataverse, use dataverse_contents instead. Contents might include one or more “datasets” and/or further Dataverses that themselves contain Dataverses and/or datasets. To view the file contents of a single Dataset, use get_dataset.

See Also

To manage Dataverses: create_dataverse, delete_dataverse, publish_dataverse, dataverse_contents;

To get datasets: get_dataset;

To search for Dataverses, datasets, or files: dataverse_search

Examples

# NOT RUN {
# view the root dataverse for a server
get_dataverse(":root")
dataverse_contents(":root")

Sys.setenv("DATAVERSE_SERVER" = "dataverse.harvard.edu")
# download file from:
# https://dataverse.harvard.edu/dataset.xhtml?persistentId=doi:10.7910/DVN/ARKOTI
dv <- get_dataverse("monogan")
(contents <- dataverse_contents(dv))

# get a dataset from the dataverse
d1 <- get_dataset(contents[[1]])
f <- get_file(d1$files$id[3])
# }