R包文档项目参数

时间:2016-09-27 00:54:55

标签: r documentation package devtools roxygen2

我有一套功能;一个函数有22个参数(包括...)。我最近将参数从...选项移动为完整参数,并注意到即使它在函数参数列表中以逻辑顺序描述,并且顺序相同在roxygen2 @params项目列表中,当我document()时,新项目位于底部的...项目下方,并且后面跟着另一个我在逻辑位置得到的参数太

示例:脚本如下所示:

#' @param ParameterA does something
#' @param ParameterB does something else
#' @param ... optional extras

foo <- function(ParameterA, ParameterB, ...)

Rd&amp;帮助文件看起来像这样:

Arguments

Parameter A    does something
...            optional extras
Parameter B    does something else

我知道这很小,但有谁知道如何解决这个问题?我删除了.Rd文件并重新document()编辑无效。

Imgur相册(3图片)截图:http://imgur.com/a/pUX4m

编辑:更多挖掘:我运行build&amp;重新加载,检查和查看:

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.

&#34; RC&#34;之前的最后一段here表示不再需要@usage,因为roxygen2的v3会自动生成此值。但是,尽管过去曾经工作过,但这对我来说不再适用。

1 个答案:

答案 0 :(得分:0)

找到了罪魁祸首:另一个脚本位于document()文件夹中,其中包含相同的功能(基本上是主要功能的草稿/分支,我正在尝试将其更改为)。 (我假设)BASIC = b"\x24\x4d\x3c\x00" MSP_ATTITUDE = BASIC + b"\x6C\x6C" 正在从gbm.auto.R为gbm.auto写入Rd文件,然后从gbm.auto_binonly.R覆盖Rd文件,删除所有更改。对不起的人