问题标签 [roxygen2]

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

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

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

任何提示表示赞赏！

我正在尝试在存储库中使用 roxygen2 和 devtools 在 R 文档中包含一个 hyperref 链接。 这是一个虚拟版本。

我跑

然后在 R studio 中使用 check and out 弹出这个错误：

所以我逃脱了#它并运行：

PDF 看起来不错，并且 hypref 可以工作。但是，如果我这样做：

hyperefclick me被破坏并导致：

而不是：

由 pdf (LaTeX 链接) 生成。

如何适当地转义井号 ( #) 以便 pdf 和 html 文档超链接都有效？

我把 devtools 和 roxygen2 标签放在上面，但我认为它们与这个问题无关。

会话信息按要求：

每当我Build & Reload从 RStudio 的Build窗格运行时，我都会收到消息

而且，确实，当我查看时，我的说明文件在该Suggests字段中包含一个空行。如果我删除它，它会在我尝试Build & Reload.

我勾选了该选项，并在随附的对话框中Generate documentation with Roxygen勾选了所有框。Configure...

我真的很喜欢使用 roxygen2 记录我的函数并让 RStudio 构建我的 NAMESPACE 文件和我的说明文件的一部分的工作流程。那么我怎样才能解决这个非常奇怪的小问题呢？

非常感谢，Rob Levy

我在 RStudio 中使用 roxygen2 来生成包文档。如何强制@description 部分中的以下内容显示为逐字固定字体？

我的解决方法是将它放入@examples \dontrun{}，但这不是我想要的。

@Joshua Ulrich 在这里找到了一个（非）解决方案

经过一些工作，我打算使用 roxygen2 roxygenize() 来更新我的包文档。我过去成功地做到了这一点。在这种情况下，我遇到了以下错误消息：

我不怀疑某处的变量名有问题，尽管我不知道如何找到错误的根源。

除了整理和命名空间问题之外，R CMD 检查没有发现任何问题，我的意思是使用 roxygen2 来纠正......

任何帮助，将不胜感激。

我想在 R 文档中包含一个Iverson 括号（除非有更好的方法来表示此信息；我不是数学家）。这看起来像这样。

在这里，我有这样一个表达式的有效 LaTeX 代码

我试图包含以下代码：

在详细信息部分中，roxygen2但在编译 pdf 帮助文档时会产生以下错误：

如何在 R 文档中包含这个 Iverson Bracket（除非有更好的方法来表示它，在这种情况下这是更好的方法）？请注意，删除这些行允许包编译。

我是 CRAN 包的维护者，在加载时收到以下消息：

因为我使用 plotrix 和 scales 包以及 NLP 和 ggplot 包。它们具有功能rescale和annotate共同点。这会导致最新的 CRAN 检查出现严重警告。所以我决定“修复”它。

我做了这样的描述：

并将其添加到一些 .R 文件中：

但这会导致另一个警告：

如何正确使用roxygen2'simportFrom标签？

我已阅读：https ://github.com/hadley/devtools/wiki/Namespaces

但我从一个必须这样做的例子中学到了最好的东西。我不确定如何正确格式化DESCRIPTION文件以及使用roxygen2标签来避免：

这是qdap GitHub 存储库

我有一个包 ( qdap ) 和一个随附的仅数据包 ( qdapDictionaries )，它们将被 qdap 中的某些函数使用，如第 41 行所示。我在这里使用第 454 行的 syn.env 。

我已经在 R-help 列表上询问了一个相关问题，但被告知它不适合该列表，因为它使用 roxygen2 的私有符号，但是，我实际上可以从qdapDictionaries. 我尝试简单地添加@export到描述数据集的 .R 文件中，但这会在编译时导致错误。

显然我没有正确导出这些数据集。 如何从中导出数据集qdapDictionaries以便可以@importFrom在父qdap包中使用？

以下是数据集的文档之一：

请注意，我qdapDictionaries在说明文件的 Depends 部分中列出了这些内容，但对于 R 开发版本，CRAN 检查显示我仍需要从中导入qdapDictionaries父qdap包中使用的数据集。

我正在创建一个包，对于 S3 方法，我使用它们导出它们

现在当我加载包时，然后predict在类的对象上工作myclass，但函数predict.myclass没有被导出。在 NAMESPACE 中，我只得到 entry S3method(predict,myclass)。那么有没有办法导出predict.myclass，这样用户就可以得到predict.myclass他（她）predict.myclass在控制台中写入的代码？

我正在开发一个具有功能的包forecast.myclass。我希望该功能与forecast包很好地配合使用。即当forecast包被加载时，代码forecast(object)应该forecast.myclass从我的包中调用。

因为我只需要forecast包中的通用定义forecast，并且我不使用包中的任何其他函数，所以forecast我不愿意将它包含在 Depends. 所以我通过以下方式在我的包中定义泛型：

forecast现在，当未加载包时，一切都按预期工作。但是当我加载包forecast时，在执行where is of classforecast.midas_r时不会调用。我应该如何解决这个问题？forecast(object)objectmidas_r