get_facets function

Get Dataverse facets

Dataverse metadata facets

get_facets(
  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. 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.

Details

Retrieve a list of Dataverse metadata facets.

Examples

## Not run:

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

# get facets
get_facets(monogan)
## End(Not run)

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