问题标签 [roxygen]

到目前为止，我正在学习 Roxygen 并取得了良好的进展。我已经能够记录我正在处理的大部分程序包，但我有一些地方似乎无法正确处理。请考虑以下最小 R：

list()Roxygen 刚刚删除了里面的评论，我已经确认了这一点：

我有一个选项设置基础设施，我想使用 Roxygen 来记录各个选项。我是否缩进评论似乎并不重要，将它们向左移动似乎没有帮助。将@rdname 添加到每个块似乎也无济于事。我只是期待不存在的行为吗？在另一个问题中，接受的答案是我们可以将 Roxygen 评论放在任何地方，并且它们会被收集。

所以有两个方面：我在上面遗漏了什么，如果不喜欢我的尝试，其他人如何记录单个数据项？

谢谢！

我使用 Roxygen 来生成我正在开发的包的 Rd 文件，但是我在默认参数设置为 ' 的函数方面遇到了一些问题\n'，例如：

其目的是计算'\n'字符串中的换行 ( ) 字符。问题是 R CMD check 给出警告：

在我看来，这个问题是由写入 Rd 文件引起的（通过写入标准 LaTeX 文件cat()总是需要出于某种目的使用双转义字符，例如：\\newline - 正如我所经历的那样）。如果我在分隔符上加上一个额外的反斜杠，例如：

问题仍然存在，就像它看起来像的代码一样'\\n'，但在文档（Rd 文件）中它看起来像'\n'.

我的问题有简单的解决方案吗？可能是 Roxygen 中的一个额外标签，它可以定义如何将函数的参数写入 Rd 文件？抱歉，如果问了一个太明显的问题，但是在谷歌搜索了一段时间后我迷路了。

历史： http: //permalink.gmane.org/gmane.comp.lang.r.roxygen/24

更新：使用roxygen2！

在 R 中编写包时，您可以创建 Rd 格式的帮助页面，然后将它们转换为 HTML 页面。如果帮助页面包含示例代码，则会在“示例”部分打印。

例如，包“stats”的函数“prcomp”有两个页面：

1. 仅示例代码：http ://stat.ethz.ch/R-manual/R-patched/library/stats/html/prcomp.html
2. 示例代码 + 带有数字的结果： http ://rgm2.lab.nig.ac.jp/RGM2/R_man-2.9.0/library/stats/man/prcomp.html

问题是如何生成 R 代码执行的结果，特别是包括输出数字？这对应于“结果”部分。

我使用以下命令将 Rd 转换为 HTML：

这调用了 R 函数http://stat.ethz.ch/R-manual/R-devel/library/tools/html/Rd2HTML.html。

我将不胜感激任何意见或建议。谢谢。

在大包上运行R CMD roxygen可能需要很长时间。它显然效率低下，并且无论文件自上次 roxygen 调用以来是否已更改，它都会遍历所有内容。

关于如何加快速度的任何提示？

背景

我写了一个 R 包，现在一个合作者（最近刚接触 R 的 CS 毕业生）正在编辑和重构代码。在此过程中，他将我的功能划分为更小、更通用的功能。

他正在做的事情是有道理的，但是当我开始使用 时package.skeleton()，每个函数都有一个文件。现在，他添加了主要功能所依赖的功能，但这可能在功能本身之外的用途有限。

他建议将所有功能都放在一个文件中，但我反对这一点，因为当我们处理不同的文件时更容易进行版本控制。

从那以后，我开始使用 roxygen 来记录文本中的每个函数。

问题

处理函数的推荐方法是什么：显然辅助函数应该保留在主函数中，但是我需要在多大程度上记录辅助函数？

评论中的@export建议很有帮助，但我很想知道其他人如何组织他们的代码。

Roxygen的工作方式似乎是第一行是\title，其他所有内容都在 中\details，然后任何@foo指令处理这些事情。但是 R 文档比这更丰富。我可以"\section{Llamas}{Are they ungulates?}"在 .Rd 文件中。

但是我不能让 Roxygen 做任何事情，除了把它全部包装在 \details 中。我错过了什么吗？

我有一个 hacky 解决方案，即}在我的\section. 这将结束该\details部分。然后我必须不要结束}，因为 roxygen 坚持认为它关闭了\details. 哎呀呀呀呀呀。

跟着Vignette，发现pseudoprime-package.Rd中的License、Author等信息没有写入DESCRIPTION？我做错什么了吗？

roxygenize 在以下代码上失败，并显示以下错误消息。关于这个主题的其他帖子表明有一个错位的字符。我找不到任何问题！你能发现问题吗？

Edit1
如果我从长 @return 行中取出几个词，上面的代码就可以正常工作

Edit2
在 roxygenize 调用之前添加 sessionInfo() 结果。

我正在编写一个包，它定义了一个新类、测量器和一个print方法，即print.surveyor. 我的代码工作正常，我使用 roxygen 进行内联文档。但R CMD check发出警告：

在文档对象“print.surveyor”中使用但不在代码中使用的函数/方法：打印

我使用了 Hadley 编写的以下两页作为灵感： Namespaces和Documenting functions，两者都指出正确的语法是@method function-name class

所以我的问题是：print使用 Roxygen 为我的新课程记录方法的正确方法是什么？更具体地说，我如何摆脱警告？

这是我的代码：（注释文档表明尝试修复此问题，但均无效。）

和 roxygenized 输出，即print.surveyor.Rd：

我最近被指向 Roxygen 来解决我的文档问题/懒惰。但是还有这个闪亮的 Roxygen2，在我的理解中，它在某种程度上是它自己的东西。Hadley 的打包工具需要使用 Roxygen2，但似乎没有太多的地方可以通过。

鉴于我在学习过程中从头开始：

1. 对于新用户，是否有一个用例偏爱 Roxygen 而不是 Roxygen2，或者 Roxygen2 在所有方面都更好？

2. 如果是这样，有什么资源可以学习它（最好是那些不依赖于 Roxygen 的先验知识的资源）？

3. Roxygen2 是否与 Roxygen 向后兼容（这样在学习和编写 Roxygen 上投入的时间会延续）？