man-roxygen/ply.R

In hadley/plyr: Tools for Splitting, Applying and Combining Data

#' @param .fun function to apply to each piece
#' @param ... other arguments passed on to \code{.fun}
#' @param .progress name of the progress bar to use, see
#'   \code{\link{create_progress_bar}}
#' @param .parallel if \code{TRUE}, apply function in parallel, using parallel
#'   backend provided by foreach
#' @param .paropts a list of additional options passed into
#'   the \code{\link[foreach]{foreach}} function when parallel computation
#'   is enabled.  This is important if (for example) your code relies on
#'   external data or packages: use the \code{.export} and \code{.packages}
#'   arguments to supply them so that all cluster nodes have the correct
#'   environment set up for computing.
#' @param .inform produce informative error messages?  This is turned off
#'   by default because it substantially slows processing speed, but is very
#'   useful for debugging
#' @keywords manip
#' @references Hadley Wickham (2011). The Split-Apply-Combine Strategy
#'   for Data Analysis. Journal of Statistical Software, 40(1), 1-29.
#'   \url{https://www.jstatsoft.org/v40/i01/}.