如何为具有并行后端的函数编写 R 包文档

如何解决如何为具有并行后端的函数编写 R 包文档

我想将此函数编写为 R 包

sqRSS <- function(x){
`%dopar%` <- foreach::`%dopar%`
foreach::foreach(i = x,.combine = "+") %dopar% {i**2}
}
sqRSS(1:5)

警告信息：按顺序执行 %dopar%：未注册并行后端

我知道我可以编写如下相同的 function 来注册后端：

library(future)
library(doParallel)
plan(multisession)
n_cores <- detectCores()
cl <- makeCluster(n_cores)
registerDoParallel(cores  =  detectCores())

sqRSS <- function(x){
  `%dopar%` <- foreach::`%dopar%`
  foreach::foreach(i = x,.combine = "+") %dopar% {i**2}

} sqRSS(1:5)

但是对于全能的 roxygen2 文档的恐惧不会加到我的 .R 文件和我的 `DESCRIPTION 文件中。

我需要什么 我如何在我的 include n_cores <- detectCores() 文件和 cl <- makeCluster(n_cores) 文件中registerDoParallel(cores = detectCores()) .R 和 DESCRIPTION 使其值得R 包文档？

编辑 .

library(sinew)
makeOxygen(sqRSS)

#' @title FUNCTION_TITLE

#' @description FUNCTION_DESCRIPTION

#' @param x ParaM_DESCRIPTION

#' @return OUTPUT_DESCRIPTION

#' @details 详情

#'@examples

#' \dontrun{

#' if(interactive()){

#' #EXAMPLE1

#' }

#' }

#' @seealso

#' \code{\link[foreach]{character(0)}},\code{\link[foreach]{c("foreach","foreach","foreach")}}

#' @rdname sqRSS

#'@export

#' @importFrom foreach %dopar% foreach