Docco Linear Style を使った R Markdown

Docco style を使用した Markdown vignette の例です。

Docco

Docco style for Markdown vignette を R パッケージで使用するには、

• vignettes ディレクトリ内に *.Rmd ファイルを追加
• DESCRIPTION ファイルに Suggests: knitr と VignetteBuilder: knitr を追加
• Rmd ファイル(HTML コメント内)に \VignetteEngine{knitr::docco_linear} でエンジンを指定

する必要があります。

パッケージをビルド、インストール後に、以下で vignette を見ることができます。

browseVignettes(package = 'Your_Package')

例

以下はコード chunk 例です。

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

hello markdown!

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

1+1

## [1] 2

10:1

##  [1] 10  9  8  7  6  5  4  3  2  1

rnorm(5)^2

## [1] 1.0046089 2.4860920 0.6986427 0.6092712 5.9373701

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 パッケージ (>= v0.6.2) は、カスタム HTML テンプレートをサポートしています。 knitr の docco エンジンは、カスタムテンプレートを使用して Markdown をコンパイルし HTML に出力します。:

knit2html(..., markdown.HTML.template = system.file('misc', 'docco-template.html', package='knitr'))

以上。