refine_delete {rrefine}

Delete project from OpenRefine

Description

This function allows users to delete a project in OpenRefine by name or unique project identifier. By default users are prompted to confirm deletion. The function wraps the OpenRefine API ⁠/command/core/delete-project⁠ query.

Usage

refine_delete(project.name = NULL, project.id = NULL, force = FALSE, ...)

Arguments

project.name

Name of project to be deleted

project.id

Unique identifier for open refine project to be deleted

force

Boolean indicating whether or not the prompt to confirm deletion should be skipped; default is FALSE

...

Additional parameters to be inherited by refine_path; allows users to specify host and port arguments if the OpenRefine instance is running at a location other than ⁠http://127.0.0.1:3333⁠

Value

Operates as a side-effect to delete the project. Issues a message that the project has been deleted.

References

https://docs.openrefine.org/technical-reference/openrefine-api#delete-project

Examples

## Not run: 
fp <- system.file("extdata", "lateformeeting.csv", package = "rrefine")
refine_upload(fp, project.name = "lfm")
refine_delete("lfm", force = TRUE)

## End(Not run)