フォーマットでdashboardを指定する
---
format: dashboard
---
Quartoでは、文書、プレゼンテーションに加えて、ダッシュボードを作成することができます。ダッシュボードとは、数値や統計の結果などを一覧として表示するためのHTMLを指す言葉で、通常は動的なデータ(例えば特定の株式会社の株価や毎日のプロ野球の試合の結果など)を表示するのに用いられます。ダッシュボードの例として、以下のようなものがQuartoのGallaryに示されています。
ダッシュボードには数値やグラフが表示されます。この数値やグラフの値がいつも同じなら(例えば、いつ見ても同じ日の株価が表示されていれば)、誰もそのダッシュボードに興味を抱かないでしょう。したがって、何らかの方法で表示される値やグラフが変化する(動的な)仕組みが必要です。
Quartoに動的な仕組みを持ち込む方法には、以下のようなものがあります。
leaflet
やplotly
、htmlwidgets
などの動的なライブラリを利用するShinyについては47章で説明します。また、plotly
に関しては27章、leaflet
に関しては45章で説明します。この章では、主にダッシュボードの構造とObservableについて説明します。
ダッシュボードの構造は基本的にはHTMLの構造に準じますが、ページのレイアウトについては通常のHTMLとはかなり異なります。
ダッシュボードを作成する場合には、YAMLにformat: dashboard
を指定します。
フォーマットでdashboardを指定する
---
format: dashboard
---
ダッシュボードのレイアウトは、2種類のヘッダー(## Row
と## Column
)で指定します。## Row
は横方向に長く、縦に並べた構造、## Column
は縦方向に長く、横に並べた構造を取るのに用います。
まずは## Row
について説明します。## Row
では、それぞれの行に示したい内容をヘッダー以下に示します。
Rowのレイアウト
## Row
contents1
## Row
contents2
また、## Row
以下に## Column
を指定することで、以下のように1つの行に横並びにレイアウトを行うこともできます。
Columnのレイアウト
## Row
contents1
## Row
## Column
contents2
## Column
contents3
また、ヘッダーの後ろに{width=XX%}
、{height=XX%}
を付け加えることで、RowやColumnの幅や高さを指定することができます。
上記のようにMarkdownを書くだけの場合には、要素(カード(cards)と呼びます)ごとの区切りとしてヘッダー(## Row
、## Column
)を明確に示す必要がありますが、コードブロックや後で説明するValue boxは1つのカードとして評価され、ヘッダーを間に置かなくてもカードとして評価されます。
コードブロックをカードとする
## Row
```{r}
plot(cars)
```
## Column
```{r}
plot(iris)
```
```{r}
::kable(iris |> head(5))
knitr```
タブで複数の要素を表示する場合には、ヘッダーの後ろに{.tabset}
を追加します。通常のQuartoのように:::
は必要ありません。
タブでデータを表示する
## Row {.tabset}
```{r}
plot(cars)
```
```{r}
plot(iris)
```
また、メニューバー(navbar)にタブを設定することもできます。メニューバーには、# header1
で記載した要素がタブとして示されます。
navbarにページを表示する
# Cars
```{r}
plot(cars)
```
# Iris
```{r}
plot(iris)
```
カードのタイトルは、chunk optionとしてtitle
に設定します。
カードのタイトルを表示する
```{r}
#| title: cars
plot(cars)
```
```{r}
#| title: iris
plot(iris)
```
また、以下のように{.card}
を用いてカードを設定することもできます。この{.card}
を用いる場合、title
をブランケット({}
)の中に書くことでタイトルを指定できます。
カードを作成する
:::{.card title="独立したカード"}
カードの中身 :::
value boxとは、特定の値などを大きく表示する場合に用いるもので、以下の図のようなものです。
value boxを表示する場合、以下のようにchunkにcontent: valuebox
を設定します。value boxの値はリストで設定し、名前をvalue
とします。value boxにはicon
を表示させることができます。icon
はbootstrap iconsから選択して指定します。value boxの色はcolor
を指定することもでき、primary、secondaryなどから選択、もしくはカラーコードを指定します。
value boxを使用する
```{r}
#| content: valuebox
#| title: "人口(千人)"
list(
icon = "buildings",
color = "primary",
value = pop
)```
動的なウェブサイトを作成する場合、上に記載した通りShinyなどのWebアプリケーションを用いるのが一般的です。Webアプリケーションとは、ウェブサイトで入力した内容に従い、サーバーと呼ばれるコンピュータで演算を行うことで、表示させるウェブページを動的に変化させることができるようにする仕組みを指します(詳しくは47章で説明します)。
Quartoでは、Shinyを用いて動的なHTMLを作成することができます。ただし、Shinyを用いた場合、サーバーで演算を行う必要があります。Shiny専用のサーバーとしてShinyapps.ioというものを無料で用いることができますが、無料だけにサーバーの計算能力は低く、あまりレスポンスのいいものではありません。
そもそもQuartoは静的なHTML、つまりサーバーの演算能力を必要としないHTMLを作成することを前提として作成されています。ですので、できればサーバーの演算能力を用いず、動的に見えるHTMLを作成したいところです。
動的に見えるHTMLとしては、上で紹介したように27章で説明したplotly
、45章で説明するleaflet
があります。これらを用いることでサーバーで演算を行うことなく動的なHTMLを作成することができます。
もう一つの動的に見えるHTMLを作成する方法として、Observableがあります。ObservableはD3.jsを開発したDr. Mike Bostockが開発している一連のツールで、Jupiter notebook風のObservable Notebooks、ダッシュボード風のObservable Canvasesの2つを提供しているWebサービスです。ObservableはD3.jsのグラフを比較的簡単な手順で描画できる、Javascriptベースのサービスとなっており、Rユーザーでも比較的簡単にJavascriptを使い、グラフを作成できるようになっています。
具体的には私が作成したノートやチュートリアル、グラフのギャラリーを参考にしてください。
Quartoでは、このObservableのチャンクを作成し、(動的に見える)静的なダッシュボードや文書を作成することができます。Observableのチャンクは以下のような形で、ojs
を指定して作成します。
Observableのチャンク
```{ojs}
// ココにJavascriptのコードを書く(//はコメントアウト)
= FileAttachment("iris.csv").csv({ typed: true })
irisc ```
Observableは真の意味でのサーバーレスで動的なコンテンツを作成できる、なかなか良いサービスだと思います。ただし、このObservableを使っている人は日本にも世界にもあまりいません。他のサービス(RxJS
)にObservableというのがあるようで、そちらばかりが検索に引っ掛かります。
なぜQuartoの開発チームがObservableに興味を持ったのかは謎ですが、データを表示・共有する場合にはなかなか良さそうなサービスですし、うまく使えばAPIなどを利用した動的なコンテンツも作れそうです。流行りのサービスになれるかどうかは疑わしいですが、興味がある方はObservable Notebooksから触り始めてみるとよいでしょう。
Observableのチャンクでは、上記と同じような形(FileAttachment
)でCSVを読み込むことができます。
Observable:ファイルの読み込み
```{ojs}
= FileAttachment("iris.csv").csv({ typed: true })
irisc ```
また、以下のような形でarrow
パッケージ(Richardson et al. 2025)のwrite_feather
関数を用いて、RからObservableにデータを渡すこともできます。
write_feather
```{r}
::write_feather(
arrowdata.frame(time = Nile |> time(), flow = Nile |> as.vector()),
"data.nile",
compression = "uncompressed"
)```
Observableでは以下のようにしてRのオブジェクトを受け取ります。ただし、この形で受け取ったオブジェクトは構造が複雑なので、取り扱いはやや難しめです。
ObservableでRのデータを受け取る
```{ojs}
= FileAttachment("data.nile").arrow()
nile ```
Observableでグラフを作成する場合には、以下のようにPlot.plot
関数を用います。この関数の利用方法はObservableのReferenceに記載されていますが、Plot Galleryを参考にした方がわかりやすいかもしれません。また、事前にObservable Notebooksでコードを書き、動作を確かめておくと作成しやすいでしょう。
グラフの描画
```{ojs}
.plot({
Plotmarks:[
.lineY(nile, {x: "time", y: "flow"})
Plot
]
})```
Observableでは、チェックボックスやラジオボタン、選択ボックスやスライダーなどの、様々なインプットのアイテムを表示させることができます。このインプットの結果を変数に代入し、その変数を利用して動的なコンテンツを作成することができます。以下の例では、year
、sex
、select_pref
の各変数にそれぞれ選択した値が代入されます。
インプットの作成:スライダー
```{ojs}
= Inputs.range([1920, 2020], {label: "Year", step: 1})
viewof year ```
インプットの作成:ラジオボタン
```{ojs}
= Inputs.radio(["male", "female"], {label: "性別", value: "male"})
viewof sex ```
インプットの作成:選択ボックス
```{ojs}
= Inputs.select(["北海道","青森県","岩手県","宮城県","秋田県","山形県","福島県","茨城県"], {label: "都道府県"})
viewof select_pref ```
データを取り込み、入力からオブジェクトを作成したら、入力オブジェクトに従いデータを選択する必要があります。データの選択には、dplyr
と同じようにfilter
メソッドを用います。Rを使っていると以下の表現はやや迂遠な感じを受けるかもしれませんが、特に難しいことなくデータを選択することができます。
ただし、このfilter
メソッドはarquero
というJavascriptのライブラリに設定されている関数ですので、Rのライブラリと同様に読み込む必要があります。
データのフィルタリング
```{ojs}
import { aq, op } from "@uwdata/arquero" // ライブラリの読み込み
= d_pop
d_pop_year .filter((d) => d.year == year)
```
Quartoでは、通常コードは上から下に、順に実行されます。下で定義したオブジェクトは上のコードでは利用できません。
ただし、このObservableを用いる場合、.qmd
上でのコードの順序は全く意味がなくなり、下で定義した値を上で用いることができます。Observableでは、変更があった値を観察(Observe)しており、変更があった値を含むコードをすべて即時に実行するという仕組みになっています。ですので、上記のようにデータのフィルタリングをしたとき、フィルタリングを実行したコードより上の行にそのデータを利用したグラフ描画のコードがあれば、そのコードが実行され、新しいデータに従いグラフが再描画されます。
この仕組みはShinyにも似ており、ダッシュボードを作成する際には利点がある仕組みとなっています。ただし、コードの順序と実行の順序が一致しないため、コードの可読性は低めです。
より詳しいObservableの使い方については、Observableのチュートリアルをご参照ください。
また、RstudioではObservableのコードをRstudio上で実行することはできず、Renderしないと結果を確認できません。また、作成されたHTMLはデプロイしないと中身を確認できません(Terminalでquarto preview
を実行すると動くので、サーバー環境でのみ使えるようになっているようです)。Observable Notebooksでは即時にコードが実行されるため、あらかじめObservable Notebooksでコードを書いておくと、Quartoに持ち込む際に役に立つでしょう。
プレビューを表示するquarto previewコマンドコマンド
quarto preview ojs.qmd # ojs.qmdがRenderされ、プレビューが表示される