r - 文档对象中非文件包固定的链接

Question

在我的R包检查中，我得到一些有关文档链接的警告。

* checking Rd cross-references ... WARNING
Non-file package-anchored link(s) in documentation object 'show_sig_consensusmap.Rd':
  ‘[NMF:consensusmap]{NMF::consensusmap}’

Non-file package-anchored link(s) in documentation object 'show_sig_number_survey2.Rd':
  ‘[NMF]{summary}’

奇怪的是，这样的警告仅在debian OS中发生。

package sigminer_1.0.7.tar.gz does not pass the incoming checks automatically, please see the following pre-tests:
Windows: <https://win-builder.r-project.org/incoming_pretest/sigminer_1.0.7_20200616_163758/Windows/00check.log>
Status: OK
Debian: <https://win-builder.r-project.org/incoming_pretest/sigminer_1.0.7_20200616_163758/Debian/00check.log>
Status: 1 WARNING

我只能通过删除链接来删除此警告。但是删除后，我的用户将无法通过单击链接获取更多信息。



有更好的解决方案吗？

Answer 1

看来，如果您使用\code{\link[pkg]{foo}}形式的链接指向包含多个功能的帮助页面，则该链接应仅指向核心功能。

例如，假设在同一帮助页面中描述了foo_1和foo_2函数，而foo_1是主要功能(即显示在帮助页面的左上角)。

要创建foo_2的链接，您应该使用\code{\link[pkg:foo_1]{foo_2}}。

有关编写R扩展的信息，请参见this GH issue和this reference。