RパッケージのHTMLヘルプページの図（Rコードの実行結果）

Question

Rにパッケージを書き込むときに、ヘルプページをRd形式で作成し、HTMLページに変換することができます。ヘルプページにサンプルコードが含まれている場合は、セクション「例」に記載されています。

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

例えば、パッケージ "統計" の機能 "prcomp" の2つのページがあります

質問は、Rコード実行の結果をどのように生成するか、特に出力数値を含めるかどうかです。これはセクション「結果」に対応します。

私はHTMLにRdのを変換するには、次のコマンドを使用します。

R機能​​を呼び出し

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

。

ご意見やご提案ありがとうございます。おかげさまで

Answer 1

helprパッケージをチェックアウトして、ドキュメントのWebフロントエンドを提供することができます。このドキュメントでは、他の多くの改良点と同様に、例の結果が表示されます。

Answer 2

あなたのコメントのために@rcsと@hadleyに感謝します。

実際、両方の提案された解決策は私のニーズに合わないようです。トランジションRoxygen> Rdを使用すると、イメージをRd形式で埋め込むことはできません。パッケージ 'helpr'は本当に印象的ですが、あなたのコンピュータにインストールしたすべてのパッケージの知識ベースを構築するのに適していると思います。私はパッケージ開発者として自分自身で変更を行う柔軟性を備えた、より基本的なものが必要でした。

最後に、私は期待したものを得ました。fitSpline.html。それは私が質問に入れたリファレンスページ、prcomp.htmlと非常によく似ています。

私は、パッケージ "tools"を採用して、少なくとも今のところ、HTMLドキュメントにイメージを持たせる方法がないことを発見しました。したがって、入力上でRdファイルを取得し、セクション '\ examples'を抽出し、Sweaveを実行してhtml/image出力を取得するbashスクリプトを作成しました。その後、 'Results'セクションのhtml部分が 'R CMD Rdconv -t html'コマンドで取得されたhtmlページとマージされます。

これは多くのコードのようですが、私はRパッケージも書いている人たちと私のソリューションを共有したいだけです。

私はあなたがR 2.14 (see here)に出てくる新しいソリューションがあることを知らせる考え敬具、 アンドレイ

#!/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

：

Rdのマークアップは非常に新しい\フィギュアタグを持っていますその数字はHTMLまたはLaTeXに変換されたときに ヘルプページに含めることができます。 par（）とpoints（）のヘルプページには、 のヘルプページの例があります。

あなたのhelprライブラリは素晴らしいと思いますが、CRANに新しいバージョンを入れたら、試してみたいと思います。