相关疑难解决方法(0)

当多个参数匹配时,如何在单个参数上使用@inheritParams?

我希望记录一个R函数,并在多个参数名称匹配时从其他函数继承单个参数文档.例如,假设我有以下2个功能.

#' Function 1.
#' 
#' Description of function 1.
#' 
#' @param x XYZ
#' @param y ZYX
#' @return Numeric
fun1 <- function(x, y) {value <- 1}

#' Function 2.
#' 
#' Description of function 2.
#' 
#' @param x ABC
#' @param y CBA
#' @return Numeric
fun2 <- function(x, y) {value <- 2}
Run Code Online (Sandbox Code Playgroud)

我现在想要创建第三个函数,它继承fun1的参数x和fun2的参数y.以下不起作用:

#' Function 3.
#'
#' Description of function 3.
#'
#' @inherit fun1 params x
#' @inherit fun2 params y
fun3 <- …
Run Code Online (Sandbox Code Playgroud)

r devtools roxygen2

14
推荐指数
1
解决办法
468
查看次数

是否有可能从另一个包中的函数@inheritParams?

我为一个模糊的TSV格式写了一个导入器,我想打包并记录:https://github.com/katrinleinweber/MWX-import/commits/package

导入器函数传递一个重命名的skip_lines参数, utils::read.table所以我想将后者的文档"传递" skip到我的.Rd.但是,尝试一些@inheritParams utils::read.table skip总是会产生一些符号Warning: Failed to find topic […].

在阅读http://r-pkgs.had.co.nz/man.htmlhttps://blog.rstudio.org/之后,我是否真的可以从另一个包的函数继承一个特定的参数2017/02/01/roxygen2-6-0-0 /.

可能吗?如果是的话,谢谢你的任何暗示!

documentation r roxygen2

6
推荐指数
1
解决办法
523
查看次数

标签 统计

r ×2

roxygen2 ×2

devtools ×1

documentation ×1