5

我读过的

我已经阅读了这个 SO question 和相关答案,但我仍然有点不知道如何defunct在我的包中正确记录函数。

我试过的

  • defunct通过调用替换了我的功能代码.Defunct("<pointer to a function to be used instead>", "<my package name>")
  • 我删除了.Rd包含我的函数的旧文档的文件
  • 我创建了mypackage-defunct.Rd一个别名指向我现在的defunct函数名称的文件
  • mypackage-defunct.Rd我为我的旧函数创建了一个\usage条目并将函数参数替换为\dots(因为我认为不需要跟踪旧参数。我遵循了一些在base-defunct中所做的事情)

我有什么

运行时 RCMD CHECK我得到以下信息WARNING

检查 Rd \usage 部分...警告文档对象'mypackage-defunct''...'中的未记录参数

具有 \usage 条目的函数需要具有适当的 \alias 条目,并记录其所有参数。\usage 条目必须对应于语法上有效的 R 代码。请参阅“编写 R 扩展”手册中的“编写 R 文档文件”一章。

我想拥有什么

我如何摆脱警告?我需要记录函数的参数defunct吗?额外问题:对于已失效的功能,推荐的方法是什么。我应该删除所有参数并用 替换它们...吗?查看base-defunct,我看到混合了具有正确参数名称的函数,.以及 ...参数和空参数列表。什么是“正确”的方式?

4

0 回答 0