item_rm: Remove item from SB

Description Usage Arguments Value Examples

View source: R/item_rm.R

Description

Remove an item from ScienceBase. This is not reversible and will delete an item and its attached files. (advanced) Recursive is to be used with care and could result in unexpected file deletion.

Usage

1
item_rm(sb_id, ..., recursive = FALSE, session = current_session())

Arguments

sb_id

An sbitem object or a character ScienceBase ID corresponding to the item

...

Additional parameters are passed on to GET, POST, HEAD, PUT, or DELETE

recursive

logical, FALSE by default. CAUTION: setting recursive=TRUE means that not only will this item be deleted, but so will all its child items and their child items and so on.

session

Session object from authenticate_sb. Defaults to anonymous or last authenticated session

Value

httr response object

Examples

1
2
3
4
5
## Not run: 
res <- item_create(user_id(), "item-to-delete")
item_rm(res)

## End(Not run)

sbtools documentation built on May 29, 2017, 7:40 p.m.