R/run_archivers.R

In femoerman/LEEF-BEMOVI: Data Package Containing Only Data and Data Information

#' Run archivers queue
#'
#' Run all the archivers registered with \code{add_archiver()}.
#'
#' @param input directory to be archive, including subdirectories
#' @param output director in which the archive will be created
#'
#' @return returns the results of the queue as a vector of length of the queue.
#'   If an element is \code{TRUE}, the function was run successfully (i.e.
#'   returned \code{TRUE})
#'
#' @export
#'
#' @examples
#' \dontrun{
#' run_archivers(
#'   input = "./input",
#'   output = "./output"
#' )
#' }
run_archivers <- function(
  input,
  output
) {

  dir.create( output, showWarnings = FALSE, recursive = TRUE)

  result <- run(
    input = input,
    output = output,
    queue = "archivers"
  )

  invisible(result)
}