.Rd链接到建议的包

时间:2012-08-21 15:28:58

标签: r documentation rd

我的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(但该电子邮件没有答案)。

2 个答案:

答案 0 :(得分:6)

Writing R Extensions Cross-References部分表示要链接到其他包使用

\link[otherpkg]{foo}

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

答案 1 :(得分:3)

最后,我将otherpkg作为依赖。