dvn (version 0.3.5)

dvDeleteStudy: Delete (or deaccession) a study

Description

Use Data Deposit API to delete an unreleased study or deaccession a released study.

Usage

dvDeleteStudy(  objectid, dv=getOption('dvn'), user=getOption('dvn.user'), pwd=getOption('dvn.pwd'),  browser=FALSE, ...)

Arguments

objectid

Either a character string containing the id for a dataverse study (a handle) or an object of class “dvStudyAtom”. This could be returned from dvUserStudies (or, dvSearch, from the Data Sharing API).

dv

An optional character string specifying the Dataverse to query. Default is the Harvard IQSS Dataverse.

user

A character string containing a dataverse username. Default is options('dvn.user').

pwd

A character string containing the corresponding dataverse password. Default is options('dvn.pwd').

browser

A logical specifying whether the query should be executed in a web browser. Default is FALSE.

...

Optionally, additional arguments passed to getURL via dvDepositQuery.

Value

Details

If a study has been created but not released, dvDeleteStudy will delete it permanently.

If a study has been created and released, dvDeleteStudy will deaccession it (i.e., reverse the release). A released study can be “deaccessioned” (replacing its public record with a publicly visible record about its previous release) using dvDeleteStudy. Currently, a previously released study cannot be deleted. Attempting to delete a deaccessioned study will produce an error.