问题标签 [roxygen]

在 R 包中的数据文档中（通过 Rstudio 使用 Roxygen），是否可以包含使用该数据的示例？

例如 R 目录下的 TestPackage.R

在同一个 R 目录中，我有一个文件：allNewColours.rda，它仅包含值为#E85100的变量aNewColour。

当我在 R studio的Build菜单上按Check时（相当于我相信的命令R CMD Check），我收到以下错误消息：

** 例子

curve(dnorm,from=-4,to=4,col=aNewColour,lwd=2) plot.xy(xy, type, ...) 中的错误：找不到对象“aNewColour”调用：曲线->绘图-> plot.default -> plot.xy 执行停止错误：命令失败（1）执行停止

以状态 1 退出。

是否可以在“aNewColour”的文档示例中使用数据“aNewColour”？

编辑：好的，我发现了我的问题 - 如果我将.rda文件移动到数据文件夹（与R文件夹处于同一级别，一切正常）......多年来一直在努力解决这个问题，只是为了在几秒钟内确定解决方案发布这个问题...

要生成 R 文档文件 ( .Rd)，我将 RStudio/Document 选项包与 R 3.0.2、Linux 3.11、devtools 1.5、roxygen2 4.0.1 一起使用。

客观的

我想在文档文件中描述一个函数的多个参数，例如在这个例子中：

在这里，参数arg1和arg2由空格字符分隔。这会导致 HTML 版本中的自动换行符。

问题

使用 RStudio/Document 选项，两个参数之间的空格将第二个参数放在“描述”部分，例如：

会变成

不适当的解决方案

我想出将两个参数都保留在“参数”部分中的唯一方法是不被空格分割，例如：

会变成

这是不想要的，因为带有更多参数的“列”使用大量空间。我试图用\或来逃避空间，\\以及用 来包含所有参数\code{...}，但没有一个能按预期工作。

问题

有没有办法像我的Objective一样创建输出？也许是一些引入空格的转义字符？

谢谢你。
斯文

我想知道在 R 中编写包期间是否有可能链接到 R 中不包含任何功能但只有包信息的文档页面？例如\link[stats]{stats-package.R}？

几次前，roxygen2 文档（R 包以方便编写 R 包的文档）包含可用 roclet 的完整列表。

在我安装在笔记本电脑上的新版本中，我无法找到它。它还在某处可用吗？或者有什么方法可以从 R 中获取它？

我正在尝试通过 roxygen2 在包中添加文档。我能够成功创建包装，并且在加载时也能够使用这些功能。这是我对如何做的理解，我在 RStudio 上创建了一个空的 R-Package 项目，然后有一个名为“getSomething.R”的源文件。内容如下，

现在，我构建并加载了理想情​​况下的包，在 /man 文件夹中创建带有 .Rd 文件的包，并开始执行“？getSomething”。但是使用该命令没有任何结果，也没有创建 Rd 文件。我在这里错过了什么吗？在我的原始项目中，我添加了一些依赖包。

以下是描述文件，

还有 NAMESPACE 文件，

exportPattern("^[[:alpha:]]+"

我想我错过了一些重要的步骤。

我有一个带有 S3 泛型和几种方法的包。我使用相同的函数来处理多个类，因此我将相同的函数分配给多个名称。我遇到的具体问题是 roxygen2 没有意识到这两个变量都绑定到 S3 方法，并且在不包含@S3method指令的情况下，它无法导出某些 S3 方法。但是，这会导致弃用警告（“@S3method 已弃用。请改用@export”）

以下（人为的）小例子说明了这个问题：

@S3method如果不使用已弃用的指令，我无法找到导出矩阵、字符和整数方法的方法。有没有办法在不使用弃用指令的情况下导出这些方法？

谢谢！

我正在使用 roxygen 生成 R 文档，除了添加此示例之外，一切都运行良好

错误信息是：

当我删除该条目，the example条目，一切正常，我可以构建包并将其提交到 git 存储库并发布它

你能帮忙吗？

更新 1：在第一个答案之后，我将示例更改为：

我在 R studio 中没有收到错误，但是当我提交到 git repositry 时，所有函数的所有文档都已损坏，现在我收到此错误

当我尝试在 RStudio 中使用 roxygen2::roxygenize() 时，我收到一条错误消息。我收到的信息是这样的：

警告消息：trainModel.Rd 不是由 roxygen2 生成的。跳过。

我已经尝试了很多来解决这个问题，但除非我删除所有 #' 注释（这将首先删除使用 roxygen2 的目的），否则它不会得到修复。我什至取出了除了描述标题、描述和细节的部分之外的所有内容，但错误仍然存​​在（这让我想象错误出现在这三个部分之一。但是如何？）。我的另一个文档的 Rd 文件生成得很好，但这个没有。有人可以帮忙吗？

我看到 library(roxygen) 中的 Curry 函数出现了奇怪的行为。这是一个最小的例子：

在这种情况下，调用

返回 11。我期望 2。

有 2 个修复对我来说没有任何意义 - 一个是扁平化循环，如

这样可行。此外，在原始循环中放置一个函数评估是可行的——如

然后我们有

这是怎么回事？

我是 Roxygen 的新手，并使用 Roxygen 来记录我的函数和脚本（我不是在构建包，而是使用包结构以便能够使用 Roxygen）。我使用Rd2HTML函数将 .Rd 转换为 .html。我正在尝试在一个 .Rd 文件中创建指向另一个 .Rd 文件的超链接，并在 .html 文件中维护该链接。

假设我有两个脚本和 .Rd 文件：code1和code2. 当我添加\code{\link{code1}}到 roxygen 注释中，code2运行roxygenize("<location of package>")并使用Rd2HTML来构建一个 html 文件时，结果是 html文件在. 换句话说：code1的html文件中没有显示超链接，而是格式化为code返回。添加包名称不能解决问题。code1\code{\link{code1}}code1

谁能解释这种行为（并解决我的问题:)）？

详细信息：命名空间文件：

描述文件：