如何正确记录已失效的功能?

时间:2017-11-06 08:27:35

标签: r rd

我读过的内容

我已阅读this SO question and related answers但我仍然有点不知道如何在我的包中正确记录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条目的函数需要具有相应的\别名   条目及其所有参数都记录在案。   \ usage条目必须对应于语法上有效的R代码。   请参阅“写入R”中的“编写R文档文件”一章   扩展手册。

我想拥有什么

我如何摆脱警告?我是否需要记录来自defunct函数的参数?奖金问题:失效功能的推荐方法是什么?我应该删除所有参数并将其替换为...吗?查看base-defunct,我看到混合的函数与正确的参数名称,....参数以及空参数列表。什么是“正确”的方式?

0 个答案:

没有答案