r - 在 knitr 输出中包含 R 帮助

Question

是否可以在 knitr 输出中包含 R 文档？使用股票数据集时，最好只包含内置文档而无需复制和粘贴。问题似乎是 ?通过副作用起作用，因此没有有意义的“结果”。例如，

```{r}
?mtcars
```

没有被 knitr 捕获的输出。

使用 help(...,help_type)而不是 ?也没有帮助。我试过了:

```{r, results='markup'}
help(mtcars, help_type="text")
```

和

```{r, results='asis'}
help(mtcars, type="html")
```

结果相同。 (在后一种情况下， knitr 确实捕获了输出 ## starting httpd help server ... done ，这基本上只是关于副作用的消息。)

换句话说，有没有办法以纯文本或 HTML 格式提取 R 帮助？

Answer 1

要回答您的具体问题，“有没有办法以纯文本或 HTML 格式提取 R 帮助？”，答案是使用 Rd2HTML 的组合。或 Rd2txt来自“工具”包，在 .getHelpFile 的帮助下来自“实用程序”。

对于 HTML:

tools:::Rd2HTML(utils:::.getHelpFile(help(mtcars)))

对于.txt:

tools:::Rd2txt(utils:::.getHelpFile(help(mtcars)))

不过，根据它的声音，您应该可以使用 function I've linked to in the comment above .例如，要包含“mtcars”帮助页面的“描述”部分中的文本，您可以使用以下内容:

```{r, echo=FALSE, results='asis'}
cat(helpExtract(mtcars, section = "Desc", type = "m_text"))
```