Delete a dataset draft
delete_dataset(
dataset,
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...
)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 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 logical.
This function can be used to delete a draft (unpublished) Dataverse dataset. Once published, a dataset cannot be deleted. An existing draft can instead be modified using update_dataset.
get_dataset, create_dataset, update_dataset, delete_dataset, publish_dataset
if (FALSE) { # \dontrun{
meta <- list()
ds <- create_dataset("mydataverse", body = meta)
delete_dataset(ds)
} # }