【问题标题】:\code{\link{function-name}} in roxygen2roxygen2 中的 \code{\link{function-name}}
【发布时间】:2015-04-13 08:45:15
【问题描述】:

这是我第一次编写 R 包。我按照链接http://kbroman.org/pkg_primer/中给出的说明使用了roxygen2@

除了少数几件事外,一切都运行良好。可能有一个更简单的解决方案来解决这些问题,但我没有找到线索我做错了什么。我希望此博客中的某人可以提供解决我的问题的解决方案。

第一个问题是关于 roxygen2 中的 {\code\link{function-name}}: 在 .R 脚本中,我加入了这一行:

#' @seealso \code{\link{s2a}} 

记录(生成 .Rd 文件)后,没有指向 s2a 的超链接, 在文档中 s2a 显示像普通文本而不是超链接.. export(s2a) 在 NAMESPACE 中列出。 还有什么地方需要修改吗?

第二个问题是关于data(): 我将数据集保存为 .Rdata 格式并放在包目录中的 data/ 中。我还在 R/ 中创建了 .R 脚本,如下所示http://kbroman.org/pkg_primer/pages/data.html

在说明文件中 LazyData: true .

但是当我在 R 控制台中输入 data(shh) 时会给出警告消息

数据(嘘) 警告信息: 在 data(shh) 中:找不到数据集“shh”

任何想法都会有很大帮助:)

【问题讨论】:

  • #' @seealso \code{\link{s2a}}
  • 你试过没有代码标签的@seealso \link{s2a}吗?
  • @MamounBenghezal :是的,我试过了,它也不起作用。
  • 我也有同样的问题,不知道别人下载我的包时,其他电脑是否正常?

标签: r roxygen2


【解决方案1】:

您问这个问题已经有一段时间了,但是我遇到了完全相同的问题,文档中的超链接显示不正确,所以对于可能遇到类似问题的任何人:您是否可能查看开发文档?链接似乎在那里不起作用。 (如果您在运行?your_function_name 时在控制台输出中看到Using development documentation for your_function_name,您就会知道是这种情况。)

链接应该出现在非开发文档中。要生成它,您可以尝试构建和重新加载您的包,例如按照以下步骤操作:http://r-pkgs.had.co.nz/man.html#man-workflow-2

【讨论】:

  • 我遇到了同样的问题,生成非开发文档解决了,谢谢。
猜你喜欢
  • 2012-12-27
  • 2011-02-25
  • 1970-01-01
  • 2023-02-09
  • 2020-06-05
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多