R/submit_batch.R

Defines functions submit_batch

Documented in submit_batch

#' Submit the Batch for Processing
#' 
#' 
#' @param batch_id ID for the batch. Required. String.
#' @param \dots Additional arguments passed to \code{\link{captr_POST}}.
#' 
#' @export
#' @references \url{https://shreddr.captricity.com/developer/}
#' 
#' @examples \dontrun{
#' submit_batch("batch_id")
#' }

submit_batch <- function(batch_id = "", ...) {

  if ( is.null(batch_id) | identical(batch_id, "")) stop("Provide a Valid Batch ID.")

  res <- captr_POST(path = paste0("batch/", batch_id, "/submit"), ...)

  res

}

Try the captr package in your browser

Any scripts or data that you put into this service are public.

captr documentation built on May 30, 2017, 6:39 a.m.