R/check_args.r

In mschubert/clustermq: Evaluate Function Calls on HPC Schedulers (LSF, SGE, SLURM, PBS/Torque)

#' Function to check arguments with which Q() is called
#'
#' @param fun    A function to call
#' @param iter   Objects to be iterated in each function call
#' @param const  A list of constant arguments passed to each function call
#' @return       Processed iterated argument list if 'iter' is a list
#' @keywords     internal
check_args = function(fun, iter, const=list()) {
    if (!is.list(iter) || length(iter) == 0)
        stop("'iter' needs to be a list with at least one element")

    # check function and arguments provided
    funargs = formals(fun)
    required = names(funargs)[unlist(lapply(funargs, function(f) class(f)=='name'))]
    required = setdiff(required, "...")

    if (length(iter) == 1 && length(required) == 1 && is.null(names(iter)))
        names(iter) = required

    provided = names(c(iter, const))

    sdiff = unlist(setdiff(required, provided))
    if (length(sdiff) > 1)
        stop(paste("If more than one argument, all must be named:",
                   paste(sdiff, collapse=" ")))

    sdiff = unlist(setdiff(provided, names(funargs)))
    if (length(sdiff) > 0 && ! '...' %in% names(funargs))
        stop(paste("Argument provided but not accepted by function:",
                   paste(sdiff, collapse=" ")))

    dups = duplicated(provided)
    if (any(dups))
        stop(paste("Argument duplicated:", paste(provided[[dups]], collapse=" ")))

    if (!is.data.frame(iter)) {
        df = data.frame(..placeholder.. = seq_along(iter[[1]]))
        for (field in names(iter))
            df[[field]] = iter[[field]]
        df$..placeholder.. = NULL
        df
    }
}