.Rd链接到建议的软件包

14
我的 hyperSpec 软件包提供了处理光谱数据集的功能。我为许多来自其他软件包的函数提供了 hyperSpec-methods。但是,我将一些这些其他软件包列为 Suggests:,因为我不想强制用户安装像其他 20 个包(包括依赖项)这样多的软件包,如果他们可能永远不会使用特定的功能。
从编码的角度来看,这很好用。然而,我在 .Rd 文件中不知道如何处理这个问题 - 但我相信这是一个相当普遍的问题。
通常的\code{\link[otherpkg]{fun}}不能可靠地工作,因为没有保证 otherpkg 可用。如果未安装该软件包,则链接将断开。这将被 R CMD check 在 Winbuilder 和 r-forge 中检测到。这意味着:该软件包将无法通过 CRAN 检查。
哪些软件包是值得参考的好例子?
目前我找到唯一的提示(尽管没有解决方案):https://stat.ethz.ch/pipermail/r-devel/2009-November/055425.html(但是那封电子邮件没有回答)。
2个回答

6

Writing R Extensions中的交叉引用部分指出,要链接到其他包,请使用以下代码:

\link[otherpkg]{foo}

需要注意的是,复杂/晦涩的问题在于foo是您想要链接到的html帮助页面的名称(在软件包内,不需要[mypkg],而且foo将是另一个man页中的\alias)。帮助页面的名称由定义您想要检索的帮助的Rd文件中的\name指令确定。


1
是的,但这仅在安装了“otherpkg”时才有效,否则链接将会失效。如果“otherpkg”在“Suggests:”中而不是“Depends:”中,我就不能依赖于该链接。我澄清了问题。 - cbeleites unhappy with SX

3
最终,我将otherpkg作为依赖项。

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接