问题标签 [roxygen2]

这比问题更令人烦恼，但是有没有办法防止在 R 中的文档被编译并且行太长时发生行“溢出”？

使用以下创建的一些文档的片段R CMD Rd2pdf [options] files：

我在任何地方都找不到提到这一点，Rd2pdf 的唯一选择是：

我正在接管一个现有的包。在 R 需要显式导出函数之前，该包是用 .Rd 文档编写的。

我的第一步是使用 Rd2roxygen 将文档转换为roxygen（非常感谢 Yihui 和 Hadley 的这个包！）。

但是现在该包不起作用，因为没有导出功能。我宁愿默认导出所有功能。在这一点上，我的一般方法似乎是确定一个可以为每个函数找到的正则表达式（##' @return将是一个很好的目标）并插入 ##' @export它上面的行，

在伪代码中：

结果将是替换：

和

获取函数列表并将它们添加到 NAMESPACE 将不起作用，因为如果不在每个函数上方的 roxygen 代码中，devtools::document("mypackage")它将覆盖它。@export

问题：将 @export 添加到包中每个函数的 roxygen 文档中的最有效方法是什么？

一个更好的选择是相应地解析NAMESPACE和解析export和method语句。

有人可以提供一个如何正确使用模板标签的例子Roxygen2。我试图做最明显的事情（对我来说）：

在我的packageName-package.R文件中：

然后在一个文件中 someFunction.R

我得到错误：

我试图有一个地方来记录常见的重复定义示例等。当这些东西嵌套在我一直在使用的一组函数中时@inheritParms。但是有些东西，如定义和其他描述，在几个地方使用。我已经搜索了高和低的使用@templateand@templateVar并没有找到任何东西。

谢谢。

我教了一门课，让学生使用我写的包。现在课程即将结束，我想为他们提供每个函数的代码，这些代码与函数的文档内联。我可以设置一个全局标志来完成此操作吗？某种代码破解？

在尝试为自己找到关于这个问题的解决方案的同时，我发现自己陷入了尝试编写有效的 Rd 标记的过程中。我想要的是添加一个名为的部分并将Raw Function Code函数的代码放在它下面。通过编写脚本来修改 Rd 文件以包含

但是，即使我在 .Rd 文件中手动正确分隔文本（使用空格或制表符），每行的初始空白似乎也会被剥离，留下一个不受欢迎的功能。我注意到，如果我在空白之前提供一个起始字符，则会保留空白。但是，我不想提供起始字符，因为我希望人们能够直接从生成的 PDF 中复制和粘贴。

我已经查看了parseRd，并且我知道有三种类型的文本 LaTeX-like、R-like 和 verbatim。我试图将我的函数代码放在 \code 和 \verb 中，但似乎都没有产生预期的结果。我能做些什么来保持我最初的空白？

我写了一个小包供我自己使用，使用 devtools 一切都很顺利。但是，我尝试在其上运行 R CMD Check，但出现了许多错误，这似乎是因为我的用法和示例使用了不在我的包中的基本 R 中的函数，例如这是我的最小函数和 roxygen 文档

和 R CMD Check 给出

有没有办法告诉 R CMD Check / roxygen2 这些功能在 base 中描述？

是否有某种机制可以让我转换 roxygen 看到的评论，最好是在它进行 roxygen->rd 转换之前？

例如，假设我有：

现在，假设我想在 roxygen 解析注释之前对注释进行一些转换，例如将反引号中的所有实例替换为\code{}. IE：

我可以preprocess以某种方式输入 roxygen，以便它在 doclet 之前（或在这种情况下可以工作）roxygen 生成文档之前在 doclet 上运行它？

我不想在我的.r文件中进行永久查找替换。正如您可能从我的示例中猜到的那样，我的目标是在我的 roxygen 注释中提供一些基本的降价支持，因此希望保持我的.r文件原样以保持可读性（并以\code{..}编程方式插入内容）。

我是否应该编写自己的版本，在我的文件中所有检测到的 roxygen 样式注释上roxygenise运行preprocess，将它们临时保存在某个地方，然后在这些上运行实际 roxygenise版本？

我正在使用devtools构建 R 包，并且有些功能并非旨在对最终用户可见。但是，由于这些函数涉及到调用 C 代码.Call，所以我必须@useDynLib在函数上方编写 .Rd 文件的自动生成。这样，当我构建包时，即使我没有包含@export这些功能，它们仍然出现在帮助文档中......有没有办法抑制这些功能，即使它们已经记录在案？谢谢！

短版：我可以使用Normal包中的文档来模拟吗？statsroxygen

长版：我正在开发一个包，并试图通过在一个标题下收集许多具有通用输入/参数的函数来使文档更具可读性，这将是对该组的通用引用。每个功能仍应可供最终用户独立使用。

我以文档为灵感，Normal其中提供了许多与正态分布相关的方法，例如stats::dnorm()。

当我搜索时，?dnorm我发现帮助部分的名称Normal即使Normal看起来不是导出的函数或对象。

我尝试将以下内容放入funs.R：

然后我roxygen2在上面运行。困难在于，R CMD check在这个最小包上运行时，它发现包无法加载为undefined exports: funs. 如果我删除##' @name funs包通过R CMD check但帮助部分的名称sum1而不是funs. 如果我在示例部分下方添加以下内容：

它通过了，我可以看到格式化为我想要的帮助，但我正在导出一个无意义的函数以使名称正确显示。

我尝试查看源帮助文件stats以了解它是如何实现的，但它们的.Rdx格式我不确定如何显示。

另外，在相关的说明中，是 什么样的事情Normal？

更新：

@TylerRinker - 恐怕这是我尝试的第一件事。这会将函数组合到一个.Rd文件中，但相关帮助的名称与第一个函数的名称相同，这是我试图避免的：

@Andrie - 这个解决方案导致完全相同的困难，帮助的名称与第一个函数相同。

也许这只是不可能的......

我想在记录 R 函数的上下文中排版方程中的矩阵。事实上，默认情况下不适amsmath用于 R 文档，并且由于已经打开了相应的数学环境而无法使用。eqnarray\deqn

那么，专业人士是如何做到的呢？通过tabular或一些这样的？