訳注: このvignette を出力する際は、ターミナルで R-3.6 CMD Sweave docco-classic.ja.Rmd とします。

Docco Classic Style を使った R Markdown

訳注: このvignette を出力する際は、ターミナルで R-3.6 CMD Sweave docco-classic.ja.Rmd とします。

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_classic} でエンジンを指定

する必要があります。

パッケージをビルド、インストール後に、以下で 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] 0.59883246 0.68885785 0.02296595 0.04904484 0.05466305

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\) を描いてみてください。

plot of chunk unnamed-chunk-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 に出力します。:

head(knitr::rocco, 5)

##                                                                                   
## 1 function (input, ...)                                                           
## 2 {                                                                               
## 3     out = knit2html(input, ..., stylesheet = system.file("misc",                
## 4         "docco-classic.css", package = "knitr"), template = system.file("misc", 
## 5         "docco-classic.html", package = "knitr"))

以上。

(訳注: 2行目はオリジナルでは x = readLines(‘docco-linear.Rmd’)[-(1:7)] でした。)

二つの列の幅をカーソルで調整したことに気づいたことがありますか？ さらに、キーボードの T を押して、何が起こるか見てみてください。