Retrieve metadata. To actually download a data file,
see get_file or get_dataframe_by_name.
get_dataset(
dataset,
version = ":latest",
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...,
use_cache = Sys.getenv("DATAVERSE_USE_CACHE", cache_dataset(version))
)
dataset_metadata(
dataset,
version = ":latest",
block = "citation",
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...,
use_cache = Sys.getenv("DATAVERSE_USE_CACHE", cache_dataset(version))
)
dataset_files(
dataset,
version = ":latest",
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...,
use_cache = Sys.getenv("DATAVERSE_USE_CACHE", cache_dataset(version))
)A character specifying a persistent identification ID for a dataset,
for example "10.70122/FK2/HXJVJU". Alternatively, an object of class
“dataverse_dataset” obtained by dataverse_contents().
A character specifying a version of the dataset.
This can be of the form "1.1" or "1" (where in "x.y", x is a major
version and y is an optional minor version), or
":latest" (the default, the latest published version).
We recommend using the number format so that
the function stores a cache of the data (See cache_dataset).
If the user specifies a key or DATAVERSE_KEY argument, they can access the
draft version by ":draft" (the current draft) or ":latest" (which will
prioritize the draft over the latest published version.
Finally, set use_cache = "none" to not read from the cache and re-download
afresh even when version is provided.
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.
one of "disk", "session", or "none", describing how datasets are cached to reduce network traffic. See cache_dataset for details.
A character string specifying a metadata block to retrieve. By default this is “citation”. Other values may be available, depending on the dataset, such as “geospatial” or “socialscience”.
A list of class “dataverse_dataset” or a list of a form dependent
on the specific metadata block retrieved. dataset_files returns a list of
objects of class “dataverse_file”.
get_dataset retrieves details about a Dataverse dataset.
dataset_metadata returns a named metadata block for a dataset.
This is already returned by get_dataset, but this function allows
you to retrieve just a specific block of metadata, such as citation information.
dataset_files returns a list of files in a dataset, similar to
get_dataset. The difference is that this returns only a list of
“dataverse_dataset” objects, whereas get_dataset returns
metadata and a data.frame of files (rather than a list of file objects).
if (FALSE) { # \dontrun{
# https://demo.dataverse.org/dataverse/dataverse-client-r
Sys.setenv("DATAVERSE_SERVER" = "demo.dataverse.org")
# download file from:
dv <- get_dataverse("dataverse-client-r")
contents <- dataverse_contents(dv)[[1]]
dataset_files(contents[[1]])
get_dataset(contents[[1]])
dataset_metadata(contents[[1]])
Sys.unsetenv("DATAVERSE_SERVER")
} # }