R markdown(knitr)パッケージのchunk optionまとめ
R markdownファイル(Rmd)にRのコード片(以下、chunk)を埋め込む際のオプションがたくさんあって覚えきれないから、よく使いそうなものだけでもまとめておきたい。ここで言うchunkってのはR markdownファイル中に記述することが出来る
```{r eval=FALSE, error=FALSE} opts_chunk$set(prompt=TRUE, message=FALSE) summary(cars) ```
というようなRのコード片の事で、そのオプションってのはこの例だと"eval"や"error"に該当。
opts_chunk$set(prompt=TRUE, message=FALSE)
と書いた内容(prompt=TRUE, message=FALSE)に関してはグローバルな設定となるので、他のchunkには書かなくてもここで設定したものが適用される。
要するにOptions - Chunk options and package options - Yihui Xie | 谢益辉の俺用まとめです。また別途、簡易リファレンスカード(英語・PDF)もあったので、これ読んでおけば大体いいかも。RPubsにも例が上がっていて、これを見るのも参考になる。
オプション | デフォルト値 | 型 | 意味 | |
---|---|---|---|---|
eval | TRUE | logical | chunkを実際にRのコードとして評価するか否か | |
echo | TRUE | logical/numeric | chunkを出力として表示するか否か。echo=2:3等ともかけてこの場合2・3番目のコードのみ出力。逆にecho=-4だと4番目のコード以外出力*1 | |
warning | TRUE | logical | chunkに対する警告を表示させるか否か | |
error | TRUE | logical | chunkに対するエラーを表示させるか否か | |
prompt | FALSE | logical | プロンプトの文字(例:>)を実行したコードの結果として追加するか否か | |
comment | '##' | character | 計算結果の頭につく文字 | |
include | TRUE | logical | chunk・実行結果を出力(通常、RStudio使ってるならHTML)に入れるか否か。これをFALSEにしてもRのコードは実行される点に注意。 | |
message | TRUE | logical | message関数の結果を表示させるか否か(パッケージ読み込む時に表示されるメッセージ等の事) | |
highlight | TRUE | logical | コードをシンタックスハイライトするか否か | |
tidy | TRUE | logical | 出力されるchunkをformatRパッケージのtidy.source()関数で整形するか否か | |
fig.width/height | 7 | numeric | 図のプロットのサイズ、"出力"画像のサイズであり、貼り付けのサイズではない点に注意(単位:インチ) | |
results | 'markup' | character | 結果の出力を(markup/asis/hide)の三択の文字列から選択。markup・asisはmark upした結果(markup)か生のRの結果か(asis)が違う。xtableなんかでテーブルをHTML出力してるのなら生のままにしなければならないのでasisを選択するってかんじで使う。hideは結果を表示しない | |
cache | FALSE | logical | 出力される計算結果をキャッシュするか否か | |
out.width/height | - | character | 実際の図のプロットのサイズ、出力のタイプに応じてpixel, %とかいろいろとれる | |
out.extra | - | character | 各出力タイプ固有の追加オプションを書く(例:'style="display::none"', 'angle=90') | |
fig.cap | - | character | 図のキャプション(例:fig.cap="図:Aの散布図") |
(俺が使うものを上に配置し、大体降順に整理)
*1:chunkオプション全てに言えることだが、Rの関数や評価結果の値を代入することが可能