【Quarto】チャンクオプションまとめてみた【R Markdown】

はじめに

どうも Quarto ユーザーです。普段チャンクオプションをよく忘れるので、備忘録も兼ねてまとめます。おそらく R Markdown も同じです。

直感的な分かりやすさ重視です。

私が普段使うものに偏っているかもしれませんが、ご了承ください。

前提

Quarto でも R Markdown と同じようなチャンクオプションの書き方ができるのですが、ここでは Quarto 独自の書き方で進めます。

理由は単純に私が好んで使っているからです。

R Markdown の書き方

R Markdown

```{r cars, echo=TRUE}
plot(cars)
```

cars の部分がチャンクのラベル（名前）、echo=TRUE の部分がチャンクオプションです。

Quarto の書き方

Quarto

```{r}
#| label: fig-cars
#| echo: true

plot(cars)
```

チャンク内で #| の後に書きます。ちなみに、こちらは TRUE や FALSE が小文字で大丈夫です。

チャンクオプション

共通

R Markdown と Quarto で共通のオプションをざっくり表にしました。これを使えば普段は問題なさそうというものをピックアップしています。

チャンクオプションまとめ
オプション	デフォルト	効果
`echo`	TRUE	コードを出力に含めるか否か FALSE にすると、実行結果のみが表示される
`include`	TRUE	コード、結果を出力に含めるか否か FALSE にすると、何も表示されないパッケージの読み込みなど重要じゃない箇所で重宝
`warning`	TRUE	警告を出力に表示するか否か基本 FALSE が多いグローバルに指定することが多い（後述）
`message`	TRUE	メッセージを出力に表示するか否か結果に付随してくる文を消すために FALSE が多いグローバルに指定することが多い（後述）
`cache`	FALSE	実行結果をキャッシュするか否か TRUE にすると、結果が保存され2回目以降の出力が高速化重い作業でコンパイルに時間がかかるときに使っている
`eval`	TRUE	コードを実際に評価するか否かコードを見せたいだけのときに FALSE にすると便利

違うやつ

よく使うものの中でもR Markdown と Quarto で異なるものをピックアップします。

fig 系
- R Markdown では fig.cap
- Quarto では fig-cap
- これ以外にも R Markdown はピリオドで、Quarto ではハイフンのものは多々あります。
チャンクラベル¹
- R Markdown は {r hogehoge}²
- Quarto はコード内で #| label: fig-hogehoge
  - ご覧の通り、Quarto の方は fig- を前に付ける必要があります³。

グローバルオプション

全部の警告やメッセージを消したい、なんてこともよくあると思います。

R Markdown と Quarto でそれぞれやり方がありますのでご紹介します。

R Markdown

RStudio であれば新しい R Markdown ファイルを開くと既に出ていますが、以下の関数を使用します。

knitr::opts_chunk$set(echo = TRUE)

括弧内に、カンマで区切りながらオプションを TRUE, FALSE などで指定していきます。echo はデフォルトで TRUE なので、これだけなら無くても大丈夫です。笑

例えば、全てのコードについてコードは出力せず結果だけ出力し、警告やメッセージは非表示にするためには次のようにします。

knitr::opts_chunk$set(echo = FALSE, warning = FALSE, message = FALSE)

Quarto

Quarto では YAML ヘッダーで設定が可能です。YAML ヘッダーは Markdown ファイルを開いたときの最上部に出てくる --- で囲まれた部分です。

次のように設定します。

YAML ヘッダー

---
title: "Untitled"
format: html
execute: 
  echo: false
  warning: false
  message: false
---

execute: で指定することができます。

おわりに

今回は私がよく使うチャンクオプションを中心にご紹介しました。

今後いろいろ使いながらアップデートしていきたいと思います。

ご参考になれば幸いです。

注

相互参照のために使うので、必ずつけなければならないものではありません。相互参照についてはこちら ↩︎
スペースを空けてチャンクラベルを入力します。↩︎
表なら tbl-hogehoge とします。↩︎

--- title: "【Quarto】チャンクオプションまとめてみた【R Markdown】" description: | チャンクオプションは忘れやすい！ date: 2024-05-09 date-modified: last-modified categories: - R - Quarto - R Markdown - 備忘録 image: thumbnail.png --- ## はじめにどうも Quarto ユーザーです。普段チャンクオプションをよく忘れるので、備忘録も兼ねてまとめます。おそらく R Markdown も同じです。直感的な分かりやすさ重視です。私が普段使うものに偏っているかもしれませんが、ご了承ください。 ## 前提 Quarto でも R Markdown と同じようなチャンクオプションの書き方ができるのですが、ここでは Quarto 独自の書き方で進めます。理由は単純に私が好んで使っているからです。 ### R Markdown の書き方 ````{.markdown filename="R Markdown"} ```{r cars, echo=TRUE} plot(cars) ``` ```` `cars` の部分がチャンクのラベル（名前）、`echo=TRUE` の部分がチャンクオプションです。 ### Quarto の書き方 ````{.markdown filename="Quarto"} ```{r} #| label: fig-cars #| echo: true plot(cars) ``` ```` チャンク内で `#|` の後に書きます。ちなみに、こちらは TRUE や FALSE が小文字で大丈夫です。 ## チャンクオプション ### 共通 R Markdown と Quarto で共通のオプションをざっくり表にしました。これを使えば普段は問題なさそうというものをピックアップしています。 +------------+------------+---------------------------------------------------------+ | オプション | デフォルト | 効果 | +:===========+:==========:+:========================================================+ | `echo` | TRUE | - コードを出力に含めるか否か | | | | - FALSE にすると、実行結果のみが表示される | +------------+------------+---------------------------------------------------------+ | `include` | TRUE | - コード、結果を出力に含めるか否か | | | | - FALSE にすると、何も表示されない | | | | - パッケージの読み込みなど重要じゃない箇所で重宝 | +------------+------------+---------------------------------------------------------+ | `warning` | TRUE | - 警告を出力に表示するか否か | | | | - 基本 FALSE が多い | | | | - グローバルに指定することが多い（[後述](#sec-global)） | +------------+------------+---------------------------------------------------------+ | `message` | TRUE | - メッセージを出力に表示するか否か | | | | - 結果に付随してくる文を消すために FALSE が多い | | | | - グローバルに指定することが多い（[後述](#sec-global)） | +------------+------------+---------------------------------------------------------+ | `cache` | FALSE | - 実行結果をキャッシュするか否か | | | | - TRUE にすると、結果が保存され2回目以降の出力が高速化 | | | | - 重い作業でコンパイルに時間がかかるときに使っている | +------------+------------+---------------------------------------------------------+ | `eval` | TRUE | - コードを実際に評価するか否か | | | | - コードを見せたいだけのときに FALSE にすると便利 | +------------+------------+---------------------------------------------------------+ : チャンクオプションまとめ ### 違うやつよく使うものの中でもR Markdown と Quarto で異なるものをピックアップします。 1. fig 系 - R Markdown では `fig.cap` - Quarto では `fig-cap` - これ以外にも R Markdown はピリオドで、Quarto ではハイフンのものは多々あります。 2. チャンクラベル^[相互参照のために使うので、必ずつけなければならないものではありません。相互参照については[こちら](../240509_cross_reference/index.html)] - R Markdown は `{r hogehoge}`^[スペースを空けてチャンクラベルを入力します。] - Quarto はコード内で `#| label: fig-hogehoge` - ご覧の通り、Quarto の方は `fig-` を前に付ける必要があります^[表なら `tbl-hogehoge` とします。]。 ## グローバルオプション {#sec-global} 全部の警告やメッセージを消したい、なんてこともよくあると思います。 R Markdown と Quarto でそれぞれやり方がありますのでご紹介します。 ### R Markdown RStudio であれば新しい R Markdown ファイルを開くと既に出ていますが、以下の関数を使用します。 ```{.r filename="R"} knitr::opts_chunk$set(echo = TRUE) ``` 括弧内に、カンマで区切りながらオプションを TRUE, FALSE などで指定していきます。`echo` はデフォルトで TRUE なので、これだけなら無くても大丈夫です。笑例えば、全てのコードについてコードは出力せず結果だけ出力し、警告やメッセージは非表示にするためには次のようにします。 ```{.r filename="R"} knitr::opts_chunk$set(echo = FALSE, warning = FALSE, message = FALSE) ``` ### Quarto Quarto では YAML ヘッダーで設定が可能です。YAML ヘッダーは Markdown ファイルを開いたときの最上部に出てくる `---` で囲まれた部分です。次のように設定します。 ```{.yml filename="YAML ヘッダー"} --- title: "Untitled" format: html execute: echo: false warning: false message: false --- ``` `execute:` で指定することができます。 ### おわりに今回は私がよく使うチャンクオプションを中心にご紹介しました。今後いろいろ使いながらアップデートしていきたいと思います。ご参考になれば幸いです。