通过noamtools包中的help_console函数获取R函数帮助,以便在.Rnw文档中使用

时间:2015-12-26 16:01:07

标签: r function noamtools

我希望使用来自R的{​​{1}}函数将.Rnw函数的帮助包含到help_console文档中,该函数可以使用以下命令从github安装:

noamtools

最低工作示例如下:

devtools::install_github('noamross/noamtools', build_vignettes = TRUE)

我没有得到正确的输出。

1 个答案:

答案 0 :(得分:2)

解决方案是包括

\usepackage{Rd}

在.Rnw文件的开头,然后使用

help_console(topic="mean", format="latex")

例如,将以下内容放在一个文件中,例如test.Rnw并编译以生成有关函数mean的文档。请注意results=tex确保R生成的Latex代码实际上是像Latex代码一样创建的。

% devtools::install_github('noamross/noamtools', build_vignettes = TRUE)
\documentclass{book}
\usepackage{Rd} % Rstudio will be able to find this .sty file

\begin{document}

<<label=Test, results=tex>>=
library(noamtools)
help_console(topic="mean", format = "latex")
@ 

\end{document}

生成一个看起来像这样的pdf,

mean

here让我意识到需要包含Rd.sty文件。运行以下代码

pack <- "ggplot2"
path <- find.package(pack)
system(paste(shQuote(file.path(R.home("bin"), "R")),
             "CMD", "Rd2pdf --no-clean", shQuote(path)))
# .Rd2xxxx directory created
# cd .Rd2xxxx

您可以查看名为.Rd2xxxx之类的已创建目录,以查找Rd2.tex,其中显示了R创建的Latex文档文件中的内容。