如何在sweave pdf中包含help（）的输出

Question

我想在sweave文档中包含帮助文件中的函数文档。我尝试了下面的sweave块

<<>>=
?lm
@

但是在Rnw文件上调用Sweave时收到错误消息。如何在文档中包含整个帮助信息？

Answer 1

关键是要弄清楚如何将所需信息作为字符串获取。

• help("lm")打开相关功能的帮助文件，但不在控制台中。
• utils:::.getHelpFile为您提供该文件的Rd版本。
• 从那里，您可以使用tools:::Rd2txt将其转换为文字...
• 可以＆＃34;捕获＆＃34;使用capture.output。

这些基本上是helpExtract from my "SOfun" package前几行中包含的步骤。但是，该功能仅捕获所请求的部分。

相反，如果你只能满足于文本，你可以按照以下方式做点什么：

gsub("_\b", "", 
    capture.output(tools:::Rd2txt(
        utils:::.getHelpFile(utils::help("lm")))))