问题标签 [roxygen2]

我正在尝试将 RSQLite 包添加到 Imports 而不是 Depends 在我的包中。在描述中我有：

在命名空间中有：

但是当我加载我的包时它失败了：

这将导致示例失败，因为dbDriver方法是由 导出的RSQLite，但未RSQLite加载命名空间。我试过添加@importMethodsFrom RSQLite dbDriver，但结果是一样的。

接下来我应该尝试什么？

我有一个R使用roxygen2. 它有一些C代码/src，我刚刚开始使用Doxygen. 有什么方法可以结合文档或将编译与 roxygen2 集成？C将代码文档放在哪里的任何“最佳实践” ？

谷歌搜索 roxygen2 和 doxygen 主要导致roxygen 类似于 doxygen结果。我发现了一些带有 Doxyfiles 的包，但没有一致的组织。例如，lme4输出到源目录之外的inst/doc/Doxyfile一个文件夹。在 Matrix 的根目录下还有一个 Doxyfile（但在以前的版本中是在.doxygenlme4inst

是否有任何理由不将C文档包含在包中，或者为什么 Doxygen 很少在 R 包中使用，尽管广泛使用C?

更新：查看相关的 roxygen2 功能请求

我有一个非常大的项目，有大约 120 个文件，每个文件有大约 50 行文档。Roxygen2 是记录我的代码的救星，但我在修复损坏的文档时遇到了一些棘手的问题。当我从 Rstudio 运行 roxygenise 时，出现以下错误。

该消息相当清楚，但不清楚它来自哪个文件。我在项目中有超过 500 个家庭标签，因此手动搜索它们并不容易，当然也不是一个长期的解决方案。

有没有办法将 roxygen 错误本地化到特定文件？我想这可以通过循环中的每个文件来实现，但我不知道如何做到这一点。

任何帮助、煽动或脚本将不胜感激，如果需要任何澄清，请在下面发表评论。

我的包文件中有两个对象 (page.height和page.width) 。sysdata.rda我已经用roxygen2这样的方式记录了它们

page.height对象已导出，但对象page.width未导出。我应该如何记录这一点，以便将两者都导出并记录在同一个帮助文件中？

我可以看到我的包安装了library()，但是当我从库中加载包时，我无法调用任何函数。

另一个用户在此处的 RStudio 帮助页面上提出了这个问题，但没有得到答复。

基本上，我已经完成了所有步骤：

(1) 安装的 Xcode

(2) 下载安装的命令行工具

(3) 安装 MacTex

(4) 选择包含带有描述文件的R包的目录。

这个包在我第一次用来构建它的 Mac 上编译得很好。然而，现在我被告知 RStudio 无法检测到DESCRIPTION 文件，即使它就在构建目录中。我附上了截图。

我得到的错误信息是：

有人知道我错过了什么吗？我附上了截图供参考。完全披露：这是针对商业应用程序的工作。

从 R 中的包运行roxygenize()命令时roxygen2，我收到以下消息：

任何如何调试此消息的想法将不胜感激。我已经尝试将我的包裹 grepping 为“22”，但没有任何相关信息出现。Traceback 也无济于事（通过 roxygen2 函数而不是我的包提供回溯）：

任何建议都非常感谢 - 谢谢。

For instance, as a minimal working example, say I have built the following package Test:

and now I change setClass to setRefClass:

when doing a 'Build & Reload' (in RStudio) I get the error

Well, of course it isn't a reference class yet, but in my updated package it will be! Checking the old class definition also throws up weird warnings:

It appears Roxygen ignores my new definition of C and the old class definition still stands. How can I get Roxygen to focus on my new definition and for my rebuild to succeed?

(Note that this problem is not specific to setClass - I'm just using it as an example.)

My setup:

I have Roxygen set up in RStudio to run before I rebuild, so that my NAMESPACE file is updated automatically if my @exports etc change.

• Roxygen2 3.0.0
  • Using roxygen to generate (in RStudio):
    • Rd files
    • Collate field
    • NAMESPACE file
  • Automatically roxygenising when running (in RStudio):
    • R CMD check
    • Source and binary package builds
    • Build & Reload
• R: 3.0.2 (Frisbee Sailing)
• IDE: RStudio 0.98.490
• OS: Windows 8.1

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

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

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

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

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

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

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