问题标签 [roxygen]

是否可以检测运行时是否有问题roxygenize（包roxygen2）？

我想自动化记录、检查和构建包的过程，并希望在记录出错时停止。

roxygenize帮助说返回值为NULL，我搜索stackoverflow没有成功。目前，我需要查看输出并搜索是否有以“错误”开头的行。

任何提示表示赞赏！

我正在尝试使用 knitr 基于具有 for 循环的 R 脚本生成 HTML 报告。我想从 for 循环中的注释生成降价注释，但我不确定是否可能。

这是一个简单的例子，这是在 test.R 中：

然后我使用 spin 生成一个 Rmd 文件： spin('test.R')

但是，Rmd 文件如下所示。

R 块中的降价注释不会编译成 HTML。可能吗？

谢谢，彼得

考虑一个XYZ由其他人编写的具有功能的基础包，ABC我想ABC通过以下方法扩展我的新（非 XYZ）包中的功能。

现在我想记录我的新函数ABC（通过 Roxygen），创建一个指向父函数的链接以供参考。

\code{\link{XYZ::ABC}}不起作用，找不到任何功能。

\link{ABC}创建指向可能候选 Rd 文件列表的链接，

如何直接创建指向BASE函数的超链接。

假设我想注释掉一个#' @export标签——记录在案的方法是什么？

在前面添加一个#（与标准 R 注释一样）似乎不起作用：##' @export foo仍然导致export(foo)在我的NAMESPACE文件中。

我还可以在 RStudio 中屏蔽掉整个 roxygen 部分吗？

例如，假设我调用了以下包Test并且我想导出类A：

A但是，在构建和加载之后，使用's 生成器时出现以下错误：

我检查了我的NAMESPACE文件的内容是好的：

那么出了什么问题呢？为什么我的类生成器没有被导出？

为了演示一个最小的案例，假设我有以下包：

当我roxygenize（在RStudio中，在“构建和重新加载”之前）。我得到：

怎么了？如何解决此错误？

我的设置：

• Roxygen2 3.1.0
  • 使用 roxygen 生成（在 RStudio 中）：
    • 文件
    • 整理字段
    • 命名空间文件
  • 运行时自动 roxygenising（在 RStudio 中）：
    • R CMD 检查
    • 源代码和二进制包构建
    • 构建和重新加载
• R：3.0.2（飞盘航行）
• IDE：RStudio 0.98.490
• 操作系统：Windows 8.1

Say I want to link to the "Details" section of my documentation for function foo, what do I do? \link{foo:Details} doesn't appear to work, so what is the right command?

当我构建我的包时，我收到了这个错误。你能帮我知道避免这个错误的步骤是什么吗？

这是我按下构建时的错误：

我正在尝试使用 roxygen2 为参考类对象制作文档，但是当我运行 R CMD 检查时，我不断收到此警告：

这是与上述警告相关的 ref 类和 roxygen2 块：

这是生成的 R 文档：

myRefClass-class {testPackaging} R 文档 myRefClass 类

描述

myRefClass 的描述

插槽

field1 一个字符槽

field2 一个数字槽

至于我能找到的文档，codoc 正在测试我的代码和文档之间的一致性。据我所知，所有插槽名称都是相同的；也许我错过了一些东西。不确定文档是否应该自动将其标记为参考类，或者我是否应该以某种方式指出这一点？我发现 R 文档表明插槽“.xData，用于启用从异常类型的继承”，但我不确定它为什么适用于我在这里所做的事情，或者我是否应该对它做一些事情。

我已经尝试了许多 roxygen 标签的排列，并保持接近此处找到的结构似乎给了我最好的结果/来自 R CMD 检查的最少警告：Roxygen2 - 如何@export 引用类生成器？ 我一直在网上寻找有关如何将 roxygen2 与参考类一起使用的示例；也许我找错地方了——我运气不太好。

我正在使用 roxygen2 v 3.1.0 / RStudio 版本 0.98.501 / R 版本 3.0.3 / OSX 10.9.2 （注意：尝试升级到 roxygen2 v 4.0 并且它完全被引用类阻塞到没有文档的地步完全生成）

如果有人知道使用 roxygen2 和参考类的 CRAN 包，以便我可以看到它是如何正确完成的，或者如果有人知道我做错了什么，我们将不胜感激。我是 R 包构建的新手。

我正在使用 roxygen 创建自己的包。我有一个导致问题的函数：

我已经创建了我的包骨架（使用 devtools 中的 create(my-package)），并且我使用了 document() 来处理 roxygen 标签。但是，当我尝试安装我的包时，它失败了：

... *安装帮助索引 ** 构建包索引 ** 测试是否可以加载已安装的包 错误：加载命名空间“my-package”时未找到对象“提取” 错误：加载失败 执行暂停

我很确定 roxygen 认为 extract.sig.metadata 是一种 S3 方法，即 export() 的一种特殊形式，但它没有找到函数 export()，所以它被破坏了。但这不是 s3 方法，它只是一个名为 extract.sig.metadata 的函数。如果我查看 Rd 代码，/usage 标记看起来很奇怪：

如果我确实将名称更改为 extractSigMetadata，则问题在技术上已解决，并且 .Rd 代码会更改，

但是我真的不想更改我的函数的名称（我的包中有数十个函数存在相同的问题，并且它们被用于一堆脚本中 - 更改我的命名将是一个巨大的痛苦架构不是）。

---> 有谁知道我如何告诉 roxygen 这只是一个正常功能而不是奇怪的 s3 方法？我猜它与@method 标签有关，但我不知道如何正确使用它来完成这项工作。谢谢！！！