Roxygen 让我的工作变得更加轻松，并且在大多数情况下都很好且直观。我从未想过的一件事是如何在@examples 部分中保留缩进，以便roxygenize("myPackage")包含的结果

将会

代替

这是一个小细节，但它使除了最简单的示例之外的所有示例都不必要地难以阅读，因此如果有人可以帮助我，我将不胜感激。

编辑：这个错误在更高版本的 roxygen 中得到了纠正。

我roxygen2用来记录我正在开发的包的数据集。我知道您可以使用 roxygen 来记录数据集，但Shane 的回答最终暗示了一个 hack，虽然我宁愿避免这样做。所以，我的问题是：

我应该将 roxygen 文档放在哪里？

我目前在我的 /R 文件夹中anorexia.sub.roxygen有一个厌食症数据集的数据文档文件 ( )

因为据我所知，这是 roxygen2 唯一会寻找它的地方：

roxygen2生成文档就好了。但是，然后它anorexia.sub.roxygen.R添加到我的Collate领域DESCRIPTION：

我想我的问题是：我怎样才能拥有 roxygen2

1. 自动从 roxygen 块生成数据文档，
2. 不要将数据文档文件添加到Collate调用中，并且
3. 避免需要破解的解决方案

我正在使用参数 use.Rd2 = TRUE 调用 roxygenize()。我有一个文件 testcase.R，我在其中使用 R.oo 创建了一个简单的 S3 对象。这是文件的内容。roxygen 在这里没有什么可做的，它应该忽略以下内容：

这是错误：

如何消除警告？根据其他帖子中的建议，我在第一行添加了以下内容，但它不起作用：

我已经阅读了 Roxygen2 PDF 和这个站点，我对 @method @S3method @export 之间的区别以及如何使用它们来正确记录 S3 方法感到迷茫。我制定了以下示例进行讨论：

1. 我将如何正确记录这些？
   
   

2. 如何模拟 ?print 和其他通用函数的文档，这些函数显示所有特定于类的实现的用例（即 ?print 显示“因子”、“表”、“函数”的用法的方式）
   
   

3. 从 wiki 页面：“所有导出的方法都需要 @S3method 标记。它与@method 具有相同的格式。这会导出方法，而不是函数 - 即 generic(myobject) 将起作用，但 generic.mymethod(myobject) 不会。”
   我无法解释这一点。这似乎是说如果标签指定不正确，函数/方法调用将无法正常工作？具体会破什么？

   MyHappyFunction = function( x , ... ) { UseMethod( "MyHappyFunction" ) }

   MyHappyFunction.lm = 函数( x , ... ) {

   做一些魔术

   }

有人能指出一个用 Roxygen 记录 R.oo 类/方法的好例子吗？在 R.oo 中，类/方法是通过调用 setConstructorS3() 和 setMethodS3() 创建的，因此本身没有记录功能。您是否只是创建标准 Roxygen 函数文档，但将其放在 NULL 语句之上？

Roxygen 在 R 中工作正常，但由于某种原因，当我尝试从命令行调用它时它会崩溃。注意到有人在 Windows 上提出了类似的投诉（此线程：R CMD roxygen notrecognized）但我现在在一个 nix 盒子上。尝试从源（install.packages("roxygen", type="source")）安装没有骰子。

想法？

是否可以在 roxygen 生成的文档中包含图像？我有许多函数本质上是 ggplot() 的包装器，我想通过显示输出示例来记录这些函数。

我收到一个roxygenize()我无法理解的错误。我有一个杂项函数包，其中 .Rd 文件是通过 roxygen 生成的。

错误是Error: titlerequires a value，这表明没有@title标签。但是文件中有一个@title标签kmmisc-package.R，所以我不确定问题是什么。

kmmisc-package.R包含：

我正在使用 R 2.13.2 和刚刚从 CRAN 重新安装的 roxygen2 2.1。完整sessionInfo()的要点在https://gist.github.com/1268056

编辑

在@andrie 的建议下，我现在有了

这仍然会产生相同的错误。

我有这篇文章的相反问题。似乎 roxygen 正在引入\n我的默认参数值，这导致 R CMD 检查警告

这是我的函数定义：

这是警告：

我在这里错过了什么吗？

我现在正在做一个项目，我一直在慢慢地从一堆不同的来源积累一堆不同的变量。作为一个有点聪明的人，我在主“original_data”目录下为每个子目录创建了一个不同的子目录，并包含一个 .txt 文件，其中包含我从中获取数据的 URL 和其他描述符。作为一个不够聪明的人，这些 .txt 文件没有结构。

现在我面临编译一个方法部分的任务，该部分记录了所有不同的数据源。我愿意浏览并向数据添加结构，但随后我需要找到或构建一个报告工具来扫描目录并提取信息。

这似乎ProjectTemplate已经有了，但我似乎无法在那里找到该功能。

这样的工具存在吗？

如果没有，应考虑哪些因素以提供最大的灵活性？一些初步的想法：

1. 应该使用标记语言（YAML？）
2. 应扫描所有子目录
3. 为了方便 (2)，应使用数据集描述符的标准扩展
4. 至关重要的是，为了使其最有用，需要某种方法将变量描述符与它们最终采用的名称相匹配。因此，要么所有变量的重命名都必须在源文件中完成，而不是在清理步骤中（不太理想），要么必须由文档引擎完成一些代码解析以跟踪变量名称的更改（啊！），或者一些应该使用更简单的混合，例如允许在标记文件中指定变量重命名。
5. 理想情况下，报告也会被模板化（例如，“我们在 [日期] 从 [dset] 数据集中提取了 [var] 变量。”），并且可能链接到 Sweave。
6. 该工具应该足够灵活，不会过于繁琐。这意味着最少的文档将只是一个数据集名称。