有什么机制可以转换roxygen看到的注释,最好是在roxygen-> rd转换之前?
例如,假设我有:
#' My function. Does stuff with numbers.
#'
#' This takes an input `x` and does something with it.
#' @param x a number.
myFunction <- function (x) {
}
现在,假设我想在roxygen解析注释之前进行一些注释转换,例如用替换反引号中所有事物实例\code{}
。即:
preprocess <- function (txt) {
gsub('`([^ ]+)`', '\\\\code{\\1}', txt)
}
# cat(preprocess('Takes an input `x` and does something with it'.))
# Takes an input \code{x} and does something with it.
我可以preprocess
以某种方式喂入roxygen,以便它将在roxygen生成文档之前(或在这种情况下可以工作)在doclet上运行吗?
我不想在.r
文件中进行永久查找。您可能会从我的示例中猜到,我的目标是在我的roxygen注释中提供一些基本的降价支持,因此希望保持.r
文件原样以保持可读性(并以\code{..}
编程方式插入内容)。
如果我只是写我自己的版本roxygenise
是运行preprocess
在我的文件中的所有检测roxygen风格的注释,它们保存暂时某处,然后运行实际的 roxygenise
那些?
roclet
在参数中指定新的rocletsroxygenize(..., roclet=mc_roclet)