dvDeleteFile: Delete a study file

In ropensci/dvn: Access to Dataverse 3 APIs

Delete a study file

Description

Use Data Deposit API to delete a study file.

Usage

dvDeleteFile(   fileid, dv=getOption('dvn'), 
                user=getOption('dvn.user'), pwd=getOption('dvn.pwd'), 
                browser=FALSE, ...)

Arguments

fileid	A character string specifying a dataverse fileId for a file contained in a dataverse record. This is distinct from the objectid that identifies the entire study in which the file is located. This could be returned from dvCreateStudy, dvStudyStatement, (or, dvExtractFileIds, 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 curlPerform via dvDepositQuery.

Details

This deletes a file in a study.

Value

If successful, the response is an empty character string.

Author(s)

Thomas J. Leeper

See Also

dvAddFile dvCreateStudy dvEditStudy dvReleaseStudy

ropensci/dvn documentation built on May 18, 2022, 9:52 a.m.