我读过的内容
我已阅读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
,我看到混合的函数与正确的参数名称,.
和...
参数以及空参数列表。什么是“正确”的方式?