osf_rm | R Documentation |
Use osf_rm()
to permanently delete a project, component, file or
directory from OSF, including any uploaded files, wiki content, or comments
contained therein. Because this process is irreversible, osfr will first
open the item in your web browser so you can verify what is about to be
deleted before proceeding.
If the project or component targeted for deletion contains sub-components,
those must be deleted first. Setting recurse = TRUE
will attempt to
remove the hierarchy of sub-components before deleting the top-level entity.
Note: This functionality is limited to contributors with admin-level permissions.
osf_rm(x, recurse = FALSE, verbose = FALSE, check = TRUE)
x |
One of the following:
|
recurse |
Remove all sub-components before deleting the top-level entity. This only applies when deleting projects or components. |
verbose |
Logical, indicating whether to print informative messages
about interactions with the OSF API (default |
check |
If |
Invisibly returns TRUE
if deletion was successful.
Other OSF file operations:
osf_cp()
,
osf_mkdir()
,
osf_mv()
## Not run:
project <- osf_create_project("My Short-Lived Project")
osf_rm(project)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.