これは、R 3.0.0以前のRでの Markdown vignette の例です。 R 3.0.0以前のRでは、Sweave/PDF vignette のみがサポートされていました。 Markdown はそのシンプルさから年々人気を集めており、R 3.0.0では R Markdown で書かれたパッケージ vignette のサポートを開始しました。

この例は R Markdown v1 専用ですのでご注意ください。 R Markdown v2 をお使いの場合は、knitr::knitr ではなく knitr::rmarkdown というvignetteエンジンをお使いください。

パッケージの vignette

Rパッケージで Markdown vignette を有効にするには、以下が必要です。

• vignettes ディレクトリの下に *.Rmd ファイルを追加します。
• DESCRIPTIONファイルにVignetteBuilder: knitr` を追加します。
• Rmdファイルの中で、vignette エンジンを VignetteEngine{knitr::knitr} と指定してください（HTMLコメント内）。

vignette を見る

RはknitrパッケージをロードしてこれらのヴィネットをHTMLファイルにビルドし、HTMLヘルプを開くとそれらを見ることができます。:

help(package = 'YourPackage', help_type = 'html')
# or see a standalone list of vignettes
browseVignettes('YourPackage')

例

下記は、例となるコードの一部です。

if (TRUE) cat('_hello_ **markdown**!', '\n')

hello markdown!

通常、chunk オプションは必要ありません。

(訳注: chunk とは、コード断片の意味。 knitr には、chunk を文章中に埋め込み、そのコードを実行させ結果を表示するなど様々なことができる。)

1+1
## [1] 2
10:1
##  [1] 10  9  8  7  6  5  4  3  2  1
rnorm(5)^2
## [1] 0.0007771972 0.6993285010 0.5477963510 0.6035413840 0.0246601183
strsplit('hello, markdown vignettes', '')
## [[1]]
##  [1] "h" "e" "l" "l" "o" "," " " "m" "a" "r" "k" "d" "o" "w" "n" " " "v" "i" "g"
## [20] "n" "e" "t" "t" "e" "s"

\(P(X>x)=\alpha/2\) という美しいプロットと数学を描いてみてください。

n=300; set.seed(123)
par(mar=c(4,4,.1,.1))
plot(rnorm(n), rnorm(n), pch=21, cex=5*runif(n), col='white', bg='gray')

markdown パッケージに組み込まれたスタイルの代わりに、独自の CSS を使うこともできます。 以下のように、markdown.HTML.stylesheet オプションを設定してください。

options(markdown.HTML.stylesheet = 'path/to/a/custom/style.css')