多个R函数共同实现复合任务时,如何编写对应的R包文档?
实现方案
1. 整合后函数代码(含R包roxygen2文档注释)
#' 计算数值向量的和、平方和与立方和 #' #' 基于foreach并行框架,一次性返回输入数值向量的一次方和、二次方和、三次方和 #' #' @param x 输入的数值向量 #' #' @return 命名数值向量,包含三个计算结果,控制台会同步打印结果与输入向量标注 #' @export #' @importFrom foreach foreach %dopar% #' #' @examples #' x <- c(1, 2) #' power_sums(x) power_sums <- function(x) { # 绑定foreach并行运算符 `%dopar%` <- foreach::`%dopar%` # 批量计算三个求和结果 ss <- foreach::foreach(i = x, .combine = "+") %dopar% {i} sss <- foreach::foreach(i = x, .combine = "+") %dopar% {i^2} qss <- foreach::foreach(i = x, .combine = "+") %dopar% {i^3} # 构造命名结果集 res <- c(ss = ss, sss = sss, qss = qss) # 控制台输出符合要求的格式,同时标注输入向量 cat("输入向量为:", paste(x, collapse = ", "), "\n") cat(names(res), "\n") cat(as.character(res), "\n") # 不可见返回结果,方便后续赋值调用 invisible(res) }
2. 效果说明
- 输入
x <- c(1, 2)运行函数时,控制台输出完全符合要求:
输入向量为: 1, 2
ss sss qss
3 5 9
- 注释完全符合roxygen2规范,直接放入R包R目录下的脚本中,运行
devtools::document()即可自动生成对应的帮助文档 - 函数支持结果赋值调用,例如运行
res <- power_sums(c(1,2))后,可通过res[["sss"]]直接提取平方和结果做后续计算
3. R包配置补充
请在DESCRIPTION文件的Imports字段添加foreach,确保打包后依赖加载正常。
内容的提问来源于stack exchange,提问作者Daniel James
相关产品推荐
相关产品推荐

