labkey.webdav.delete: Deletes the provided file/folder on a LabKey Server via...

In Rlabkey: Data Exchange Between R and 'LabKey' Server

Deletes the provided file/folder on a LabKey Server via WebDAV

Description

This will delete the supplied file or folder under the specified LabKey Server project using WebDAV.

Usage

labkey.webdav.delete(
    baseUrl=NULL,
    folderPath,
    remoteFilePath,
    fileSet='@files'
    )

Arguments

baseUrl	a string specifying the baseUrl for the labkey server
folderPath	a string specifying the folderPath
remoteFilePath	the path to delete, relative to the LabKey folder root.
fileSet	(optional) the name of file server fileSet, which is typically "@files" (the default value for this argument). In some cases this might be "@pipeline" or "@fileset".

Details

This will delete the supplied file or folder under the specified LabKey Server project using WebDAV. Note: if a folder is provided, it will delete that folder and contents.

Value

TRUE if the folder was deleted successfully

Author(s)

Ben Bimber, Ph.D.

See Also

labkey.webdav.get, labkey.webdav.put, labkey.webdav.mkDir, labkey.webdav.mkDirs, labkey.webdav.listDir, labkey.webdav.pathExists, labkey.webdav.downloadFolder

Examples

## Not run: 

library(Rlabkey)

#delete an entire directory and contents
labkey.webdav.delete(baseUrl="http://labkey/", folderPath="home", remoteFilePath="folder1")

#delete single file
labkey.webdav.delete(baseUrl="http://labkey/", folderPath="home", remoteFilePath="folder/file.txt")


## End(Not run)

Rlabkey documentation built on Nov. 8, 2023, 1:06 a.m.