R包文档项目参数顺序
R package documentation items params order
我有一个函数包;一个函数有 22 个参数(包括 ...
)。我最近将一个参数从 ...
选项移动到一个完整参数,并注意到即使它在函数参数列表中以逻辑顺序描述,并且在 roxygen2 @params 项目中以相同的顺序描述列表,当我 document()
时,新项目位于底部的 ...
项目下方,并且它本身后面跟着另一个我在逻辑位置也有的参数。
示例:脚本如下所示:
#' @param ParameterA does something
#' @param ParameterB does something else
#' @param ... optional extras
foo <- function(ParameterA, ParameterB, ...)
Rd 和帮助文件如下所示:
Arguments
Parameter A does something
... optional extras
Parameter B does something else
我知道这是小事,但有人知道如何解决这个问题吗?我删除了 .Rd 文件并重新document()
ed 无济于事。
Imgur相册(3张)截图在这里:http://imgur.com/a/pUX4m
编辑:更多挖掘:我 运行 构建并重新加载、检查和查看:
Documented arguments not in \usage in documentation object 'gbm.auto':‘tc’ ‘mapshape’.
Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
"RC" here 之前的最后一段说 @usage
不再需要,因为 roxygen2 的 v3 会自动生成它。但这对我不再有用,尽管过去曾工作过。
找到罪魁祸首:另一个脚本位于 R
文件夹中,其中具有相同的功能(本质上是主要功能的 draft/fork,我正在尝试将其更改为)。 (我假设)document()
正在为 gbm.auto 从 gbm.auto.R 写入 Rd 文件,然后从 gbm.auto_binonly.R 覆盖 Rd 文件,删除所有更改。抱歉各位
我有一个函数包;一个函数有 22 个参数(包括 ...
)。我最近将一个参数从 ...
选项移动到一个完整参数,并注意到即使它在函数参数列表中以逻辑顺序描述,并且在 roxygen2 @params 项目中以相同的顺序描述列表,当我 document()
时,新项目位于底部的 ...
项目下方,并且它本身后面跟着另一个我在逻辑位置也有的参数。
示例:脚本如下所示:
#' @param ParameterA does something
#' @param ParameterB does something else
#' @param ... optional extras
foo <- function(ParameterA, ParameterB, ...)
Rd 和帮助文件如下所示:
Arguments
Parameter A does something
... optional extras
Parameter B does something else
我知道这是小事,但有人知道如何解决这个问题吗?我删除了 .Rd 文件并重新document()
ed 无济于事。
Imgur相册(3张)截图在这里:http://imgur.com/a/pUX4m
编辑:更多挖掘:我 运行 构建并重新加载、检查和查看:
Documented arguments not in \usage in documentation object 'gbm.auto':‘tc’ ‘mapshape’.
Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
"RC" here 之前的最后一段说 @usage
不再需要,因为 roxygen2 的 v3 会自动生成它。但这对我不再有用,尽管过去曾工作过。
找到罪魁祸首:另一个脚本位于 R
文件夹中,其中具有相同的功能(本质上是主要功能的 draft/fork,我正在尝试将其更改为)。 (我假设)document()
正在为 gbm.auto 从 gbm.auto.R 写入 Rd 文件,然后从 gbm.auto_binonly.R 覆盖 Rd 文件,删除所有更改。抱歉各位