Retrieve a ddi metadata file
get_file_metadata(
file,
dataset = NULL,
format = c("ddi", "preprocessed"),
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...
)An integer specifying a file identifier; or a vector of integers
specifying file identifiers; or, if used with the prefix "doi:", a
character with the file-specific DOI; or, if used without the prefix, a
filename accompanied by a dataset DOI in the dataset argument, or an object of
class “dataverse_file” as returned by dataset_files.
Can be a vector for multiple files.
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().
Defaults to “ddi” for metadata files
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 character vector containing a DDI metadata file.
if (FALSE) { # \dontrun{
ddi_raw <- get_file_metadata(file = "nlsw88.tab",
dataset = "10.70122/FK2/PPIAXE",
server = "demo.dataverse.org")
xml2::read_xml(ddi_raw)
} # }