man-roxygen/template.R

In mllg/batchtools: Tools for Computation on Batch Systems

#' @param template [\code{character(1)}]\cr
#'   Either a path to a \pkg{brew} template file (with extension \dQuote{tmpl}), or a short descriptive name enabling the following heuristic for the file lookup:
#'   \enumerate{
#'     \item \dQuote{batchtools.[template].tmpl} in the path specified by the environment variable \dQuote{R_BATCHTOOLS_SEARCH_PATH}.
#'     \item \dQuote{batchtools.[template].tmpl} in the current working directory.
#'     \item \dQuote{[template].tmpl} in the user config directory (see \code{\link[rappdirs]{user_config_dir}}); on linux this is usually \dQuote{~/.config/batchtools/[template].tmpl}.
#'     \item \dQuote{.batchtools.[template].tmpl} in the home directory.
#'     \item \dQuote{[template].tmpl} in the package installation directory in the subfolder \dQuote{templates}.
#'   }