问题标签 [rd]

要生成 R 文档文件 ( .Rd)，我将 RStudio/Document 选项包与 R 3.0.2、Linux 3.11、devtools 1.5、roxygen2 4.0.1 一起使用。

客观的

我想在文档文件中描述一个函数的多个参数，例如在这个例子中：

在这里，参数arg1和arg2由空格字符分隔。这会导致 HTML 版本中的自动换行符。

问题

使用 RStudio/Document 选项，两个参数之间的空格将第二个参数放在“描述”部分，例如：

会变成

不适当的解决方案

我想出将两个参数都保留在“参数”部分中的唯一方法是不被空格分割，例如：

会变成

这是不想要的，因为带有更多参数的“列”使用大量空间。我试图用\或来逃避空间，\\以及用 来包含所有参数\code{...}，但没有一个能按预期工作。

问题

有没有办法像我的Objective一样创建输出？也许是一些引入空格的转义字符？

谢谢你。
斯文

你能帮我解决一个 CMD 尾随空格线的不寻常问题吗？我编写了一个简单的批处理脚本来删除文件中列出的文件夹路径。命令：

我已将测试路径名称字符串放入path.txt：

不幸的是，当脚本运行时，它将文件的内容分成两行并分别处理\\sample和path. 但是，如果我使用它ECHO而不是RD它读取整行而不考虑空格。

如何强制RD /S命令忽略空格？我也不想在文本文件中的文件夹路径中使用双引号。

我正在努力在我的一个包中记录一个可视化功能。为此，我希望通过 Rd 文件“funcname.Rd”嵌入一个图像，该图像可以解释函数中使用的各种参数，如果用户阅读包手册 PDF 或写入“？funcname”，该图像会弹出' 在 R. 中的一些东西：

'Writing R extensions'-document 似乎没有解决这个问题，我能找到的唯一参考资料是这篇博文和这个 R-devel 讨论。前者与一个名为“base64”的包的链接断开了，而后者只解决了各种替代方案，例如将图像包含在 R 包小插图中。如果这可以与 CRAN 兼容，那就太好了。

任何有关如何解决此问题的建议将不胜感激，谢谢！

我正在为函数编写 R 文档（Rd）。在 markdown 中，我们可以通过[google](https://www.google.com). 如何在 R 文档中复制它？

似乎\link{...}只能创建一个链接，这与我正在寻找的不同。

我可以使用 \item 在 .Rd 文件中创建一个列表。

但似乎我无法通过将 \item 放在另一个中来创建嵌套列表，\item如

有人知道在 R 文档中生成嵌套列表的方法吗？谢谢。

以下 MWE 无法编译（通过devtools::document()）：

无论我包含哪一条“Nope”行，它总是会因错误而失败

roxygen 块开始失败 mwe.r:1
大括号不匹配……</p>

根据我对Rd 文档的阅读，这应该通过转义大括号来工作。但是，如上所示，这不起作用。我做错了什么还是这是 Roxygen 中的错误？

当我使用单转义版本 ( format('\{')) 时，提示这可能是 Roxygen 错误的一个提示是完整的错误消息：

不匹配的大括号："@example format('{}') # Works format('\\{') # Nope"

请注意，输入中的单个反斜杠在输出中已加倍。

我正在为我正在构建的 R 包的功能编写文档。

为了使帮助文件有一个适度好的方面，我需要 ASCII 中的 \bar{x} 等价物：

我正在尝试包含一些关于 LaTeX 序言要求的注释，这些注释将需要在包中提供某些选项。我需要在文件中正确呈现以下内容.Rd，但我一直收到错误

错误：roxygen 块开始喷洒失败。R：1 不匹配的大括号：

（roxygen 标记）代码的违规部分如下

一旦我取出@符号，它就可以正常工作。如何编写@R 帮助文件？

我在 R 中为泛型 S4 函数编写了一个方法。泛型函数的名称是extract. 该方法引用的类中包含一个连字符，就像在Zelig-tobit模型中一样。我想在相应的 .Rd 文件的使用部分中为该方法编写一个文档条目，如下所示：

如果我这样做，R CMD check --as-cran将返回一条错误消息：

如何正确转义连字符？

我有一个 URL 列表，我将识别该 URL 是用于 PC 还是移动设备。URL 的 HTML 页面是否有一定的 PC 或移动标记？