35得票1回答
如何在使用Roxygen2时,通过`\link{}`链接到Rd文件的特定部分?

假设我想链接到函数foo的文档中的“Details”部分,该怎么办? \link{foo:Details}似乎不起作用,那么正确的命令是什么?

9得票4回答
R CMD roxygen未被识别。

我刚刚尝试了Roxygen包。在R中,我可以运行Roxygen Vignette中的示例。但是在命令行中,R CMD roxygen不被识别为有效命令。当我运行R CMD --help时,我可以看到所有INSTALL, check, ...sweave..., config...命令项,但没有...

13得票1回答
如何在R帮助文件/roxygen2中交叉引用方程

我正在为我创建的一个R软件包记录一些函数。 我正在使用roxygen标记,但这与我的问题大部分无关。 我已经在文档中使用\deqn{...}放置了方程。我的问题是: 是否有办法后来引用这个方程? 例如,在我的Rd文件中:\deqn{\label{test} y = mx + b } 我之后可...

65得票3回答
如何使用roxygen文档化数据集?

在roxygen过程中,是否可以将.R文件包含在数据目录中? 我已经将多个.R文件放入数据目录中。当它们通过data()被调用时,它们会读取原始数据文件并执行一些转换。

14得票1回答
如何使用Roxygen2添加类专属的别名而不是通用的别名?

一个简单的例子是,我创建了一个扩展 show 的 S4 基础方法。我不想通过重新记录 show 来引起歧义分支,并且我还想通过为新类 myPkgSpClass 添加别名 show,myPkgSpClass-method,将我的扩展文档整合到 show 的文档中。#' @export #' @a...

43得票4回答
在更新软件包的新版本中重命名函数时,有最佳/推荐实践要遵循吗?

我正在更新一个旧软件包,并缩短了一些非常长的函数名称。如何让用户知道旧函数已被弃用? 我使用 roxygen2 记录所有内容,所以我想知道是否应该使用 #' @alias ? 你有什么想法吗?

97得票1回答
Roxygen文档中的任意部分

Roxygen似乎是这样工作的:第一行是\title,剩下的全部在\details中,而且任何@foo指令都会处理这些内容。但R文档比这更丰富。我可以在.Rd文件中使用"\section{Llamas}{Are they ungulates?}"。 但是我无法让Roxygen做除了将所有内容...

34得票2回答
能否在testthat测试或run_examples()中使用R包数据?

我正在开发一个R包,使用devtools、testthat和roxygen2。在data文件夹中有几个数据集(foo.txt和bar.csv)。 我的文件结构如下: / mypackage / data * foo.txt, bar.csv / inst ...

7得票2回答
Roxygen真的可以像Doxygen为C++一样文档化R脚本(而不是软件包)吗?

Roxygen受C、C++程序员使用的Doxygen文档系统启发。我使用过Doxygen,只要有doxygen注释,就可以轻松地记录任何程序。它还为函数和类生成调用图。我认为roxygen会以同样的方式工作,但当我搜索roxygen帮助时,我只能找到关于记录R包的解决方案。 我已经检查了Ha...

11得票2回答
使用roxygen2处理示例文件:反斜杠会被复制(\dontrun变成\\dontrun)

实际问题 如何避免在包含示例的单独文件中,\dontrun{ 成为 roxygenize 后相应 Rd 文件中的\\dontrun{? 我找到了一个解决方法,但感觉可能只是漏掉了一些明显的设置,例如 roxigenize() 的某些设置。 细节 我认为我发现了一个可能的错误或者至少不希...