Skip to contents

Delete Folder from Databrary Volume

Source: R/delete_folder.R
delete_folder.Rd

Delete (soft-delete) a folder from a Databrary volume. The folder and its associated metadata are marked as deleted but not permanently removed from the database.

Usage

delete_folder(vol_id = 1, folder_id, vb = options::opt("vb"), rq = NULL)

Arguments

vol_id

Target volume number. Must be a positive integer.

folder_id

Numeric folder identifier. Must be a positive integer.

vb

Show verbose messages. (Defaults to FALSE, overwritable using option 'databraryr.vb' or environment variable 'R_DATABRARYR_VB')

rq

An httr2 request object. Defaults to NULL.

Value

TRUE if the folder was successfully deleted, FALSE otherwise.

See also

create_folder, update_folder, patch_folder

Examples

# \donttest{
if (FALSE) { # \dontrun{
delete_folder(vol_id = 1, folder_id = 42)
} # }
# }