Question

在R，包文档中，我想知道是否可以动态生成@param字段及其内容。我已经意识到可以实现以下目标：

rd_helper = function(what,desc){
    sprintf("Description for %s is %s",what,desc)
}

#' @param x \Sexpr[results=rd,stage=build]{rd_helper('x','xvalue')}
#' @param y \Sexpr[results=rd,stage=build]{rd_helper('y','yvalue')}
testfunction = function(x,y){
   #Nothing
}

但对于我的特殊情况，这仍然是很多工作。

我有一个包含60个参数的函数，我想生成整个＆＃34; @param .....＆＃34;使用循环，我可以在逻辑上确定参数名称和相应的描述。

以下不会奏效，但它应该提供我想要实现的目标：

rd_helper2 = function(what,desc){
    lapply(seq_along(what),function(ix){
      sprintf("#' @param %s Description for %s is %s",
              what[ix], what[ix],desc[ix])
    })
}

#' @param x \Sexpr[results=rd,stage=build]{rd_helper('x','xvalue')}
#' \Sexpr[results=rd,stage=build]{rd_helper2(c('x,'y'),c('xvalue','yvalue')) }
testfunction = function(x,y){
   #Nothing
}

以上是否有可能？

R Roxygen文档 - 自动生成的@param字段

0 个答案: