irm {rirods} | R Documentation |
Remove Data Objects or Collections in iRODS
Description
This is the equivalent of file.remove()
, but applied to an item inside
iRODS.
Usage
irm(
logical_path,
force = TRUE,
recursive = FALSE,
catalog_only = FALSE,
verbose = FALSE
)
Arguments
logical_path |
Path to the data object or collection to remove. |
force |
Whether the data object or collection should be deleted
permanently. If |
recursive |
If a collection is provided, whether its contents should
also be removed. If a collection is not empty and |
catalog_only |
Whether to remove only the catalog entry. Defaults to
|
verbose |
Whether information should be printed about the HTTP request
and response. Defaults to |
Value
Invisibly the HTTP call.
See Also
imkdir()
for creating collections,
file.remove()
for an R equivalent.
Examples
is_irods_demo_running()
# connect project to server
create_irods("http://localhost:9001/irods-http-api/0.2.0")
# authenticate
iauth("rods", "rods")
# some data
foo <- data.frame(x = c(1, 8, 9), y = c("x", "y", "z"))
# store
isaveRDS(foo, "foo.rds")
# check if file is stored
ils()
# delete object
irm("foo.rds", force = TRUE)
# check if file is deleted
ils()
[Package rirods version 0.2.0 Index]