delete_dataset {dataverse} | R Documentation |
Delete draft dataset
Description
Delete a dataset draft
Usage
delete_dataset(
dataset,
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
...
)
Arguments
dataset |
A character specifying a persistent identification ID for a dataset,
for example |
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
|
server |
A character string specifying a Dataverse server.
Multiple Dataverse installations exist, with |
... |
Additional arguments passed to an HTTP request function, such as
|
Details
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
.
Value
A logical.
See Also
get_dataset
, create_dataset
, update_dataset
, delete_dataset
, publish_dataset
Examples
## Not run:
meta <- list()
ds <- create_dataset("mydataverse", body = meta)
delete_dataset(ds)
## End(Not run)