dataverse (version 0.2.0)

delete_dataset: Delete draft dataset

Description

Delete a dataset draft

Usage

delete_dataset(dataset, key = Sys.getenv("DATAVERSE_KEY"),
  server = Sys.getenv("DATAVERSE_SERVER"), ...)

Arguments

dataset

An integer specifying a dataset identification number or an object of class “dataverse_dataset”. The identification number is the dataset's persistent identification number (not the integer specifying a specific version of the dataset, such as returned by dataset_versions).

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 Sys.setenv("DATAVERSE_KEY" = "examplekey").

server

A character string specifying a Dataverse server. There are multiple Dataverse installations, but the defaults is to use the Harvard Dataverse. This can be modified atomically or globally using Sys.setenv("DATAVERSE_SERVER" = "dataverse.example.com").

...

Additional arguments passed to an HTTP request function, such as GET, POST, or DELETE.

Value

A logical.

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.

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)
# }