如何在 sweave pdf 中包含 help() 的输出

How to include output of help() in sweave pdf

我想在 sweave 文档中包含来自帮助文件的功能文档。我尝试了以下 sweave 块

<<>>=
?lm
@

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

关键在于弄清楚如何以字符串的形式获取您想要的信息。

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

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

相反，如果您可以只满足于文字，您可以按照以下方式做一些事情：

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