【问题标题】:.Rd links to suggested package [closed].Rd 链接到建议的包[关闭]
【发布时间】:2012-08-17 00:00:00
【问题描述】:

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

【问题讨论】:

    标签: r documentation rd


    【解决方案1】:

    最后,我把otherpkg 做了一个依赖。

    【讨论】:

      【解决方案2】:

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

      \link[otherpkg]{foo}
      

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

      【讨论】:

      • 是的,但只有在安装了otherpkg 时才有效,否则链接会断开。如果otherpkgSuggests: 而不是Depends:,我不能依赖那个链接。我澄清了这个问题。
      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2013-05-29
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多