man-roxygen/generic-algo.R

In rickhelmus/patRoon: Workflows for Mass-Spectrometry Based Non-Target Analysis

#' @details \code{<%=func%>} is a generic function that will <%=what%> by one of the supported algorithms. The actual
#'   functionality is provided by algorithm specific functions such as \code{<%=ex1%>} and \code{<%=ex2%>}. While these
#'   functions may be called directly, \code{<%=func%>} provides a generic interface and is therefore usually preferred.
#'
#' <%=if (!exists("noParam")) paste("@param algorithm A character string describing the algorithm that should be
#'   used:", paste0("\\code{\"", unlist(strsplit(algos, ",")), "\"}", collapse = ", ")) %>
#'
#' @seealso The \code{\link{<%=ret%>}} output class and its methods and the algorithm specific functions:
#'   <%=paste0("\\code{\\link{", func, unlist(strsplit(algosSuffix, ",")), "}}", collapse = ", ") %>