View a SWORD (possibly unpublished) dataset “statement”
dataset_atom(
dataset,
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...
)
dataset_statement(
dataset,
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...
)A dataset DOI (or other persistent identifier), an object of class “dataset_atom” or “dataset_statement”, or an appropriate and complete SWORD URL.
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").
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. See use_cache for details
on how the R dataverse package uses disk and session caches to
improve network performance.
A list. For dataset_atom, an object of class “dataset_atom”.
These functions are used to view a dataset by its persistent identifier. dataset_statement will contain information about the contents of the dataset, whereas dataset_atom contains “metadata” relevant to the SWORD API.
Managing a Dataverse: publish_dataverse; Managing a dataset: dataset_atom, list_datasets, create_dataset, delete_sword_dataset, publish_dataset; Managing files within a dataset: add_file, delete_file
if (FALSE) { # \dontrun{
# retrieve your service document
d <- service_document()
# retrieve dataset statement (list contents)
dataset_statement(d[[2]])
# retrieve dataset atom
dataset_atom(d[[2]])
} # }