roxygen2中的\ code {\ link {function-name}}

时间:2015-04-13 08:45:16

标签: r roxygen2

这是我编写R-package的第一次经历。我按照此链接http://kbroman.org/pkg_primer/

中给出的说明使用了roxygen2 除了少数事情之外,Everythig工作正常......可能有一个更简单的解决方案来解决问题,但我找不到线索我做错了什么。我希望此博客中的某位人员可以提供解决方案来解决我的问题。

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

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

记录(生成.Rd文件)后没有到s2a的超链接, 在文档s2a显示像普通文本不像超链接.. 出口(s2a)在NAMESPACE中列出。 我还需要修改其他地方吗?

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

步骤

在描述文件LazyData中:true。

但是当我在R控制台中输入数据(shh)时会发出警告信息

  

数据(SHH)   警告信息:   在数据(shh)中:未找到数据集'shh'

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

1 个答案:

答案 0 :(得分:6)

自从你提出这个问题以来已经有一段时间了,但我的文档中的超链接出现的问题却出现了同样的问题,所以对于可能遇到类似问题的人来说,你是否正在查看开发文档?链接似乎不在那里工作。 (如果您在运行Using development documentation for your_function_name时在控制台输出中看到?your_function_name,您就会知道这种情况。)

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