RMarkdown

R Markdownのチャンクオプション(include など)は、コードチャンクやその出力の表示方法および動作を制御するために用いる。

これにより、レポートの構成や内容を柔軟にカスタマイズすることが可能となる。

RMarkdownのチャンクオプション色々

include オプション

チャンク全体を出力に含めるか否かを制御するオプション。

  • include = TRUE: チャンクのコードと結果を出力に含める(デフォルト)。
  • include = FALSE: チャンクのコードと結果を出力に含めない。ただし、コードは実行される。
```{r, include=FALSE}
x <- 1:10
mean(x)
```

echo オプション

チャンクのコードを出力に表示するか否かを制御するオプション。

  • echo = TRUE: チャンクのコードを出力に表示(デフォルト)。
  • echo = FALSE: チャンクのコードは出力に表示されないが、結果は表示される。
```{r, echo=FALSE}
sum(1:10)
```

eval オプション

チャンクを実行するか否かを制御するオプション。

  • eval = TRUE: チャンクのコードを実行(デフォルト)。
  • eval = FALSE: チャンクのコードは実行されず、出力も生成されない。
```{r, eval=FALSE}
plot(1:10, 1:10)

results オプション

コードの結果(出力)を表示する方法を制御するオプション。

  • results = "markup": 出力を通常の形式で表示(デフォルト)。
  • results = "asis": 出力をそのまま(Markdown形式など)表示。
  • results = "hide": 結果を表示しない。
```{r, results="hide"}
summary(cars)
```

message と warning オプション

コードの実行中に発生するメッセージや警告の表示を制御する。

  • message = TRUE: メッセージを表示(デフォルト)。
  • message = FALSE: メッセージを非表示。
  • warning = TRUE: 警告を表示(デフォルト)。
  • warning = FALSE: 警告を非表示。
```{r, message=FALSE, warning=FALSE}
# メッセージや警告が表示されない
log(-1)  # これにより警告が発生するが非表示になる
```

error オプション

実行時にエラーが発生した際の挙動を制御する。

  • error = TRUE: エラーが発生しても処理を続行し、エラー内容を表示。
  • error = FALSE: エラーが発生した場合、処理を中断(デフォルト)。
```{r, error=TRUE}
# エラーが発生するがレポートの処理は続行される
stop("エラー例

fig 系オプション

チャートやプロットに関連するオプションを設定。

  • fig.width と fig.height: プロットの幅と高さを指定(単位: インチ)。例: fig.width=6, fig.height=4
  • fig.align: プロットの位置を指定。
    • fig.align = "left": 左寄せ。
    • fig.align = "center": 中央寄せ(デフォルト)。
    • fig.align = "right": 右寄せ。
  • fig.cap: 図のキャプションを設定。例: fig.cap = "このプロットの説明"
```{r, fig.width=6, fig.height=4, fig.align="center", fig.cap="デモプロット"}
plot(1:10, 1:10)
```

out.width と out.height オプション

出力される図の幅と高さを指定。

```{r, out.width="50%", out.height="50%"}
plot(1:10, 1:10)
```

cache オプション

チャンクの結果をキャッシュし、次回以降の実行時に再利用することで処理時間を短縮。

  • cache = TRUE: チャンクの結果をキャッシュ。
  • cache = FALSE: キャッシュを使用しない(デフォルト)。
```{r, cache=TRUE}
Sys.sleep(5)  # 5秒間スリープ
mean(rnorm(1000))
```

複数オプションの組み合わせ

多くのオプションを組み合わせて使うことが可能。

例:

```{r, echo=TRUE, include=TRUE, message=FALSE, warning=FALSE, fig.width=6, fig.height=4, fig.align="center", fig.cap="プロットの例"}
# プロット例
plot(1:10, rnorm(10))
```

これらのオプションを適切に組み合わせることで、R Markdownドキュメントの見た目や動作を細かく制御することができる。

チャンクオプションのまとめ

オプション 説明 主な設定値 デフォルト値
include チャンク全体を出力に含めるかを制御 TRUE(含める), FALSE(含めない) TRUE
echo チャンクのコードを出力に表示するかを制御 TRUE(表示), FALSE(非表示) TRUE
eval チャンクを実行するかを制御 TRUE(実行), FALSE(非実行) TRUE
results コード実行結果の表示方法を制御 "markup"(通常), "asis"(そのまま), "hide"(非表示) "markup"
message 実行中に出るメッセージの表示を制御 TRUE(表示), FALSE(非表示) TRUE
warning 実行中に出る警告メッセージの表示を制御 TRUE(表示), FALSE(非表示) TRUE
error 実行時にエラーが発生した際の処理を制御 TRUE(続行), FALSE(中断) FALSE
fig.width プロットの幅をインチ単位で指定 数値(例: 6) -
fig.height プロットの高さをインチ単位で指定 数値(例: 4) -
fig.align プロットの配置を指定 "left"(左寄せ), "center"(中央), "right"(右寄せ) "center"
fig.cap 図のキャプションを設定 テキスト(例: "図の説明") -
cache チャンクの結果をキャッシュするかを制御 TRUE(キャッシュ), FALSE(キャッシュしない) FALSE
collapse コードと出力をまとめて表示するかを制御 TRUE(まとめる), FALSE(分ける) FALSE
out.width 出力画像の幅を指定(%やpxで指定可能) "50%", "300px" -
out.height 出力画像の高さを指定(%やpxで指定可能) "300px" -