r - .Rd 链接到建议的包

Question

关闭。这个问题不满足Stack Overflow guidelines .它目前不接受答案。












想改善这个问题吗？更新问题，使其成为 on-topic对于堆栈溢出。

3年前关闭。




Improve this question




我的 hyperSpec包提供了处理光谱数据集的功能。我为来自其他包的相当多的函数提供了 hyperSpec 方法。但是，其中一些其他软件包，我已列为 Suggests:因为我不想强制用户安装诸如 20 个其他软件包(计算依赖项)之类的东西，如果他们可能永远不会使用特定功能。

从编码的角度来看，这很好用。但是，我不知道如何在 .Rd 文件中处理它 - 但我确定这是一个相当普遍的问题。

平常的 \code{\link[otherpkg]{fun}}将无法可靠地工作，因为不能保证 otherpkg 可用。如果未安装 otherpkg，则链接已断开。这将由 R CMD check 检测到例如在 Winbuilder 和 r-forge 上。这意味着:包不会通过 CRAN 检查。

哪些包是一个很好的例子？

到目前为止我发现的唯一提示(虽然没有解决方案):https://stat.ethz.ch/pipermail/r-devel/2009-November/055425.html (但没有回复该电子邮件)。

Answer 1

Cross-References编写 R 扩展的部分说要链接到其他包，请使用

\link[otherpkg]{foo}

棘手/难以理解的事情是 foo 是您要链接到的 html 帮助页面的名称(在一个包中，不需要 [mypkg] 和 foo 将是 \alias 在另一个人中页)。帮助页面的名称由 \name 决定Rd 文件中的指令定义您有兴趣检索的帮助。