R 包的 HTML 帮助页面中的图形（R 代码执行结果）

Question

在 R 中编写包时，您可以创建 Rd 格式的帮助页面，然后将其转换为 HTML 页面。如果帮助页包含示例代码，则会在“示例”部分中打印。

例如，“stats”包的“prcomp”函数有两个页面：

1. 仅示例代码： http://stat.ethz.ch/R-manual/R-patched/library/stats/html/prcomp.html
2. 示例代码 + 带数字的结果: http://rgm2.lab .nig.ac.jp/RGM2/R_man-2.9.0/library/stats/man/prcomp.html

问题是如何生成R代码执行的结果，特别是包括输出数字？这对应于“结果”部分。

我使用以下命令将 Rd 转换为 HTML：

R CMD Rdconv -t html $rdfile > $rdname.html

这会调用 R 函数 http://stat.ethz.ch/R-manual/R-devel/library/tools/html/Rd2HTML.html。

我将不胜感激任何意见或建议。 谢谢。

Answer 1

您可能想查看 helpr 包，它为文档提供了一个 Web 前端，以及许多其他改进，可以在线显示示例的结果。

Answer 2

感谢@rcs 和@hadley 的评论。

实际上，这两种建议的解决方案似乎都不符合我的需求。以 Rd 格式嵌入图像则并非如此，因为我使用过渡 Roxygen>Rd。 “helpr”软件包确实令人印象深刻，但我认为它更适合构建计算机中安装的所有软件包的知识库。作为一名包开发人员，我需要一些更基本、更灵活的东西来自己进行更改。

最后，我得到了我所期望的， fitSpline.html 。这与我在问题中放入的参考页面非常相似，prcomp.html。

我发现没有办法采用“工具”包来在 HTML 文档中包含图像，至少目前是这样。因此，我编写了一个 bash 脚本，该脚本在输入上获取 Rd 文件，提取“\examples”部分并通过运行 Sweave 获取 html/image 输出。然后，“结果”部分的 html 部分与通过命令“R CMD Rdconv -t html”获得的 html 页面合并。

这似乎是很多代码，但我只想与那些也编写 R 包的人分享我的解决方案。

此致，
安德烈

#!/bin/bash

rdfile="fitSpline.Rd"
rdname=$(echo "$rdfile" | cut -d'.' -f1)

rfile=$rdname.R
sed -n '/\examples{/,/}/p' $rdfile > $rfile # text between two patterns
sed -i 's/\\examples{//' $rfile # remove pattern '\examples{'
sed -i 's/}$//' $rfile # remove the character '}'

rnwfile=$rdname.Rnw
cp $rfile $rnwfile
sed -i '1 i png("Rplot%03d.png")' $rnwfile
sed -i '1 i  <<example, echo=true, results=tex>>=' $rnwfile
sed -i '$ a dev.off()' $rnwfile
sed -i '$ a @' $rnwfile

texfile=$rdname.tex
R CMD Sweave $rnwfile
sed -i 's/\\begin{Schunk}//' $texfile
sed -i 's/\\begin{Sinput}//' $texfile
sed -i 's/\\end{Schunk}//' $texfile
sed -i 's/\\end{Sinput}//' $texfile
sed -i '/^$/d' $texfile # remove empty lines

reshtmlfile=$rdname.results.html
echo "<h3>Results</h3>" > $reshtmlfile
echo "<pre>" >> $reshtmlfile
cat $texfile >> $reshtmlfile
echo "</pre>" >> $reshtmlfile

for fig in $(ls *.png) ; do
  echo "<br><a href=\"$fig\"><img src=\"$fig\"></a>" >> $reshtmlfile
done

htmlfile=$rdname.html
R CMD Rdconv -t html $rdfile > $htmlfile

sed -i 's/<\/body>//' $htmlfile
sed -i 's/<\/html>//' $htmlfile
cat $reshtmlfile >> $htmlfile
echo "</body>" >> $htmlfile
echo "</html>" >> $htmlfile

Answer 3

我想让你知道 R 2.14 中出现了一个新的解决方案 （参见此处）：

Rd 标记有一个新的 \figure 标签，以便数字可以包含在
转换为 HTML 或 LaTeX 时的帮助页面。上面有例子
par() 和points() 的帮助页面。

Hadley，你的帮助库听起来很棒，一旦你把它的新版本放在 CRAN 上，我很乐意尝试一下。