R/easy_delete.R

In sckott/resteasy: REST API from Static Files Hosted on GitHub

#' Delete a file
#'
#' @export
#' @param repo (character) Repository name. Required.
#' @param path (character) Path to file from root of repo. Required.
#' @param message (character) Commmit message. Required.
#' @param branch (character) Branch to use, Default: master
#' @param ... Curl options passed on to \code{\link[httr]{DELETE}}
#' @examples \dontrun{
#' options(github_name = "Scott Chamberlain")
#' options(github_email = "myrmecocystus@@gmail.com")
#' easy_create(x=iris, repo = "ropensci/datasets", path ="iris.csv",
#'    message = "hello world")
#' easy_delete(repo = "ropensci/datasets", path ="iris.csv",
#'    message = "delete it!")
#' }
easy_delete <- function(repo, path, message, branch = "master", ...) {
  rest_DELETE(repo, path, message, branch = branch, ...)
}