臨床研究のフローチャートが描ける ggconsort パッケージの紹介

class: center middle

## 臨床研究のフローチャートが描ける`ggconsort`パッケージの紹介

### nissinbo

---

## [R/Medicine2021の発表](https://github.com/tgerke/ggconsort-talk) が元ネタです。

- 本スライドは冗長気味に書いたので、ぜひ元ネタの方もご覧ください。
- [sample_code.R](https://github.com/nissinbo/ggconsort_introduction/blob/master/sample_code.R)に今回使用したサンプルコードを入れたので実際に動かしてみてください

---

### CONSORT diagram とは

- 臨床研究において患者選択や割り当ての流れを示したフローチャート
    - ランダム化比較試験 (RCT) の報告に焦点を当てているが、観察研究にも適用は可能（だと思う）

<br>

.h-center.w-35[
![](images/nejm-consort.jpeg)
]

---
### よくある CONSORT diagram の作り方

<br>

- [Word形式のテンプレート](http://www.consort-statement.org/consort-statement/flow-diagram)を、Officeで編集して作成することが多い

.h-center.w-50[
![](images/consort.gif)
]

---

### Officeで作図 苦手なんだよなあ

- コピペ作業、体裁を整える作業で消耗したくない
- データと紐付けて、患者数を自動で入れたい
- できれば ggplot2 で書きたい

---
### 「R でフローチャート作成」 のこれまで

- .green[ggplot2] とは異なる方法での開発が進んでいた

- .green[DiagrammeR/Graphviz]: [Wong 2018](https://dannyjnwong.github.io/STROBE-CONSORT-Diagrams-in-R/), [Higgins/Gerber 2020](https://github.com/higgi13425/ggconsort/pull/1), [Köhler 2017](https://scriptsandstatistics.wordpress.com/author/koehlern/)
  - .green[tikz]: [Gerke lab 2018](https://github.com/GerkeLab/consoRt)
  - .green[JS]: [Gerke 2021](https://github.com/tgerke/flowcharter)

.h-center.w-40[
![](images/diagrammer-consort.png)
]

---

### 期待の新星 `ggconsort`

.h-center.w-50[
![](images/ggconsort-hex.svg)
]

- ggplot2 ベースで、臨床試験や観察研究のフローチャートを作成できる！
- [Travis Gerke](https://github.com/tgerke) 作

---

## 参考資料

- [R/Medicine2021 資料](https://github.com/tgerke/ggconsort-talk)
- [R/Medicine2021 Youtube](https://www.youtube.com/watch?v=a8A638n6Qew)
- [公式リファレンス](https://tgerke.github.io/ggconsort/index.html)
- [GitHubリポジトリ](https://github.com/tgerke/ggconsort)

公式リファレンスを見れば一通り理解することができます。

---

## パッケージのインストール

- 2021年10月現在、CRAN にはないようです
- 「ggconsort」でググると先に出てくる以下のレポジトリとは異なるため注意！
    - https://github.com/higgi13425/ggconsort

```r
remotes::install_github("tgerke/ggconsort")
# https://github.com/tgerke/ggconsort
```

---

## `ggconsort` での作成手順

2つの手順でフローチャートを作成します

1. 患者数カウントとラベル付け
1. 図のレイアウトとデザイン

---
class: center middle

## 患者数カウントとラベル付け

---

### 使用するデータ

`ggconsort` のサンプルデータを表示する

- idに重複のない、患者1人につき1行のデータ

```r
trial_data
```

```
## # A tibble: 1,200 × 5
##       id declined prior_chemo bone_mets treatment
##    <int>    <int>       <int>     <int> <chr>    
##  1 65464        0           0         0 Drug A   
##  2 48228        0           0         0 Drug B   
##  3 92586        0           0         0 Drug A   
##  4 70176        0           0         0 Drug B   
##  5 89052        0           0         0 Drug A   
##  6 97333        0           0         0 Drug B   
##  7 80724        0           0         0 Drug A   
##  8 65186        0           0         0 Drug B   
##  9 48837        0           0         0 Drug A   
## 10 99005        0           0         0 Drug B   
## # … with 1,190 more rows
```

---
### コホートの開始

- `cohort_start()` で**フローチャートの始点**となるデータを指定
    - データフレームからパイプでつなげる

```r
trial_data %>%
* cohort_start("Assessed for eligibility")
```

```
## A ggconsort cohort of 1200 observations with 0 cohorts.
```

---
### 選択基準

- `cohort_define()` で患者条件を指定
    - 引数の中では `dplyr::filter` で患者を選択する
    - `.full` はコホート全体（`cohort_start`）を表す

```r
trial_data %>%
  cohort_start("Assessed for eligibility") %>% 
* cohort_define(
*   consented = .full %>% filter(declined != 1)
* )
```

```
## A ggconsort cohort of 1200 observations with 1 cohort:
##   - consented (1141)
```

---
### 選択基準

- `cohort_decline()` 内はカンマでつなげることで条件を連続で指定できる
    - 以下では、たった今定義したサブコホート （`consented`） をもとに `consented_chemonaive` を定義している

```r
trial_data %>%
  cohort_start("Assessed for eligibility") %>% 
  cohort_define(
    consented = .full %>% filter(declined != 1),
*   consented_chemonaive = consented %>% filter(prior_chemo != 1)
  )
```

```
## A ggconsort cohort of 1200 observations with 2 cohorts:
##   - consented (1141)
##   - consented_chemonaive (1028)
```

---
### 群分け

群分けもここで指定

```
## A ggconsort cohort of 1200 observations with 5 cohorts:
##   - consented (1141)
##   - consented_chemonaive (1028)
##   - randomized (938)
##   - treatment_a (469)
##   - treatment_b (469)
```

---
### 除外基準

- 除外された人数を示すためには `anti_join()` が便利

```
## A ggconsort cohort of 1200 observations with 6 cohorts:
##   - consented (1141)
##   - consented_chemonaive (1028)
##   - randomized (938)
##   - treatment_a (469)
##   - treatment_b (469)
##   - excluded (262)
```

---
### ラベル付け

`consort_label()` に実際のフローチャートで表示するラベルを入力

```r
trial_data %>%
  cohort_start("Assessed for eligibility") %>% 
  cohort_define(
    consented = .full %>% filter(declined != 1),
    consented_chemonaive = consented %>% filter(prior_chemo != 1),
    randomized = consented_chemonaive %>% filter(bone_mets != 1),
    treatment_a = randomized %>% filter(treatment == "Drug A"),
    treatment_b = randomized %>% filter(treatment == "Drug B"),
    # anti_join is useful for counting exclusions -------------
    excluded = anti_join(.full, randomized, by = "id")
  ) %>%
* cohort_label(
*   consented = "Consented",
*   consented_chemonaive = "Chemotherapy naive",
*   randomized = "Randomized",
*   treatment_a = "Allocated to arm A",
*   treatment_b = "Allocated to arm B",
*   excluded = "Excluded"
* ) -> study_cohorts
```

---
### ラベル付け

作成した `study_cohorts` は`ggconsort_cohort` オブジェクトと呼ばれ、 `summary` 関数で定義したサブコホートの一覧を表示できる

```r
summary(study_cohorts)
```

```
## # A tibble: 10 × 3
##    cohort               count label                   
##    <chr>                <int> <chr>                   
##  1 .full                 1200 Assessed for eligibility
##  2 consented             1141 Consented               
##  3 consented_chemonaive  1028 Chemotherapy naive      
##  4 randomized             938 Randomized              
##  5 treatment_a            469 Allocated to arm A      
##  6 treatment_b            469 Allocated to arm B      
##  7 excluded               262 Excluded                
##  8 excluded_declined       59 Declined to participate 
##  9 excluded_chemo         113 Prior chemotherapy      
## 10 excluded_mets           90 Bone metastasis
```

---
class: center middle

## レイアウトとデザイン

---

### `cohort_count_adorn()`

- 定義したサブコホートのラベルを表示する関数
- `.label_fn` 引数でラベルのフォーマットをカスタムできる

```r
cohort_count_adorn(study_cohorts, randomized)
```

```
## [1] "Randomized (n = 938)"
```

```r
cohort_count_adorn(
  study_cohorts, 
  .label_fn = function(cohort, label, count, ...) {
    glue::glue("{count} {label}")
  })
```

```
##  [1] "1200 Assessed for eligibility" "1141 Consented"               
##  [3] "1028 Chemotherapy naive"       "938 Randomized"               
##  [5] "469 Allocated to arm A"        "469 Allocated to arm B"       
##  [7] "262 Excluded"                  "59 Declined to participate"   
##  [9] "113 Prior chemotherapy"        "90 Bone metastasis"
```

---
### `consort_box_add()`

- Box を追加する関数
- name にはフローチャート内で使う名前を指定
- x, y には座標を入力
- `label` では `cohort_count_adorn()` を使い、事前に設定したラベル付けを適用

```r
study_cohorts %>%
* consort_box_add(
*   name = "full", x = 0, y = 50, label = cohort_count_adorn(., .full)
* )
```

---
### `consort_box_add()`

- パイプでつないで作成していく

```r
study_cohorts %>%
  consort_box_add(
    name = "full", x = 0, y = 50, label = cohort_count_adorn(., .full)
  ) %>%
* consort_box_add(
*   "randomized", 0, 30, cohort_count_adorn(., randomized)
* )
```

---
### 複数条件を1つの Box に入れる

- Box 内に複数の条件を入れる際は label 引数を編集する
    - `glue::glue()` は文字列の結合に便利な関数
    - `cohort_count_adorn()` の中身の文字列を渡す

```r
study_cohorts %>%
  consort_box_add(
    name = "full", x = 0, y = 50, label = cohort_count_adorn(., .full)
  ) %>%
  consort_box_add(
    "randomized", 0, 30, cohort_count_adorn(., randomized)
  ) %>%
* consort_box_add(
*   "exclusions", 20, 40, label = glue::glue(
*     '{cohort_count_adorn(study_cohorts, excluded)}<br>
*     • {cohort_count_adorn(study_cohorts, excluded_declined)}<br>
*     • {cohort_count_adorn(study_cohorts, excluded_chemo)}<br>
*     • {cohort_count_adorn(study_cohorts, excluded_mets)}
*     ')
* )
```

---
### フローチャートの表示

- 作成したオブジェクトを `ggplot()`に入れ、`geom_consort()` を使う
- `theme_consort()` で余白を調整

```r
study_cohorts %>%
  consort_box_add(...) %>% 
* ggplot() +
* geom_consort() +
* theme_consort(margin_h = 8, margin_v = 1)
```

---
### 群分けの Box を追加

```r
study_cohorts %>%
  consort_box_add(
    name = "full", x = 0, y = 50, label = cohort_count_adorn(., .full)
  ) %>%
  consort_box_add(
    "randomized", 0, 30, cohort_count_adorn(., randomized)
  ) %>%
  consort_box_add(
    "exclusions", 20, 40, glue::glue(
      '{cohort_count_adorn(study_cohorts, excluded)}<br>
      • {cohort_count_adorn(study_cohorts, excluded_declined)}<br>
      • {cohort_count_adorn(study_cohorts, excluded_chemo)}<br>
      • {cohort_count_adorn(study_cohorts, excluded_mets)}
      ')
  ) %>% 
* consort_box_add(
*   "arm_a", -30, 10, cohort_count_adorn(., treatment_a)
* ) %>%
* consort_box_add(
*   "arm_b", 30, 10, cohort_count_adorn(., treatment_b)
* )
```

---
### 群分けの Box を追加

---
### `consort_arrow_add()`

- Box 同士をつなぐ矢印を作るときは、「始点、終点、どの辺をつなぐか」を指定する
- 今回は "full" が始点、"randomized" が終点、始点の "bottom" から、終点の "top" に向けた矢印

```r
study_cohorts %>%
  consort_box_add(...) %>%
* consort_arrow_add(
*   start = "full", start_side = "bottom",
*   end = "randomized", end_side = "top"
* )
```

---
### Box 以外から出る矢印の作成

- 矢印の始点や終点が Box でない場合は、x/y座標を指定する
- ここでは `start_x` と `start_y` を渡して矢印の途中から新たな矢印を追加し、Box 終点となるようにしている

```r
study_cohorts %>%
  consort_box_add(...) %>%
  consort_arrow_add(
    start = "full", start_side = "bottom",
    end = "randomized", end_side = "top"
  ) %>%
* consort_arrow_add(
*   end = "exclusions", end_side = "left", start_x = 0, start_y = 40
* )
```

---
### `consort_line_add()`

矢印でなく、単なる直線を追加するときも座標を指定する

---
### `consort_line_add()`

---
### フローチャートを完成させる

`study_consort` という名前のオブジェクトとする

```r
study_cohorts %>%
  consort_box_add(...) %>%
  consort_arrow_add(
    start = "full", start_side = "bottom",
    end = "randomized", end_side = "top"
  ) %>%
  consort_arrow_add(
    end = "exclusions", end_side = "left", start_x = 0, start_y = 40
  ) %>%
  consort_line_add(
    start_x = -30, start_y = 20, end_x = 30, end_y = 20,
  ) %>%
* consort_arrow_add(
*   start_x = 0, start_y = 30, end_x = 0, end_y = 20,
* ) %>%
* consort_arrow_add(
*   end = "arm_a", end_side = "top", start_x = -30, start_y = 20
* ) %>%
* consort_arrow_add(
*   end = "arm_b", end_side = "top", start_x = 30, start_y = 20
* ) -> study_consort
```

---
### フローチャートを完成させる

- 作成したオブジェクトを `ggplot()`に入れ、`geom_consort()` を使う
- `theme_consort()` で余白を調整

```r
study_consort %>%
  ggplot() + 
  geom_consort() + 
  theme_consort(margin_h = 8, margin_v = 1)
```

---
### 他のgeom_* を使う

- ggplot に関する他の関数も使える
- 以下では、`ggtext::geom_richtext()` で2つの治療群の間にテキストボックスを追加する

```r
study_consort %>%
  ggplot() + 
  geom_consort() + 
* ggtext::geom_richtext(
*   aes(x = 0, y = 10, label = "Allocation"),
*   fill = "#9bc0fc"
* ) +
  theme_consort(margin_h = 8, margin_v = 1)
```

---
### 他のgeom_* を使う

---
### パワーポイントへ出力

- 結局 Office かい、と言われそうだが、こと医学系研究では Office を捨て去ることが難しい状況もある
- `export` を使って、図をパワポに出力することができる
    - 詳細は以下に譲る https://kato-kohaku-0.hatenablog.com/entry/2019/12/19/222429
- グループ化を解除すればパワポ上での手直しが可能
- このままだと少し体裁が崩れるので修正が必要？良い方法があれば知りたいです。

```r
study_consort %>%
  ggplot() + 
  geom_consort() + 
  ggtext::geom_richtext(
    aes(x = 0, y = 10, label = "Allocation"),
    fill = "#9bc0fc"
  ) + 
  theme_consort(margin_h = 8, margin_v = 1)

*export::graph2ppt()
```

---
### `ggconsort_cohort` からデータフレームを引き出す

- `cohort_pull()` を使うと `cohort_define()` で定義したサブコホートを抽出できる
- サブコホートを簡単に取り出せるため、感度分析やコードレビューなどに使えそう

```r
study_cohorts %>% cohort_pull(randomized)
```

```
## # A tibble: 938 × 5
##       id declined prior_chemo bone_mets treatment
##    <int>    <int>       <int>     <int> <chr>    
##  1 65464        0           0         0 Drug A   
##  2 48228        0           0         0 Drug B   
##  3 92586        0           0         0 Drug A   
##  4 70176        0           0         0 Drug B   
##  5 89052        0           0         0 Drug A   
##  6 97333        0           0         0 Drug B   
##  7 80724        0           0         0 Drug A   
##  8 65186        0           0         0 Drug B   
##  9 48837        0           0         0 Drug A   
## 10 99005        0           0         0 Drug B   
## # … with 928 more rows
```

---
### まとめ

- `ggconsort` はフローチャート作成を強力にサポートするパッケージ
- 今後の発展が楽しみ
- フローチャートに再現性と効率を！

.highlight-last-item > ul > li, 
.highlight-last-item > ol > li {
  opacity: 0.5;
  color: var(--purple);
}
.highlight-last-item > ul > li:last-of-type,
.highlight-last-item > ol > li:last-of-type {
  opacity: 1;
  font-weight: bold;
}

.remark-visible .css-typing p {
  opacity: 0;
  border-right: .15em solid orange;
  white-space: nowrap;
  overflow: hidden;
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards
}
.remark-visible .css-typing p:nth-child(1) {
  width: 100px;
  -webkit-animation: type .5s steps(9,end);
  animation: type .5s steps(9,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards
}
.remark-visible .css-typing p:nth-child(2) {
  width: 550px;
  -webkit-animation: type 2s steps(31,end);
  animation: type 2s steps(31,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards;
  -webkit-animation-delay: 1.5s;
  animation-delay: 1.5s
}
.remark-visible .css-typing p:nth-child(3) {
  width: 375px;
  -webkit-animation: type 1s steps(20,end);
  animation: type 1s steps(20,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards;
  -webkit-animation-delay: 5s;
  animation-delay: 5s
}
.remark-visible .css-typing p:nth-child(4) {
  width: 60px;
  -webkit-animation: type .5s steps(7,end);
  animation: type .5s steps(7,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards;
  -webkit-animation-delay: 7s;
  animation-delay: 7s
}

.remark-visible .css-typing-2 p {
  opacity: 0;
  border-right: .15em solid orange;
  white-space: nowrap;
  overflow: hidden;
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards
}
.remark-visible .css-typing-2 p:nth-child(1) {
  width: 100px;
  -webkit-animation: type .5s steps(9,end);
  animation: type .5s steps(9,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards
}
.remark-visible .css-typing-2 p:nth-child(2) {
  width: 600px;
  -webkit-animation: type 2s steps(31,end);
  animation: type 2s steps(31,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards;
  -webkit-animation-delay: 1.5s;
  animation-delay: 1.5s
}
.remark-visible .css-typing-2 p:nth-child(3) {
  width: 410px;
  -webkit-animation: type 1s steps(20,end);
  animation: type 1s steps(20,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards;
  -webkit-animation-delay: 5s;
  animation-delay: 5s
}
.remark-visible .css-typing-2 p:nth-child(4) {
  width: 60px;
  -webkit-animation: type .5s steps(7,end);
  animation: type .5s steps(7,end);
  -webkit-animation-fill-mode: forwards;
  animation-fill-mode: forwards;
  -webkit-animation-delay: 7s;
  animation-delay: 7s
}
@keyframes type {
  0% {
    width: 0
  }
  1% {
    opacity: 1
  }
  99.9% {
    border-right: .15em solid orange
  }
  100% {
    opacity: 1;
    border: none
  }
}
@-webkit-keyframes type {
  0% {
    width: 0
  }
  1% {
    opacity: 1
  }
  99.9% {
    border-right: .15em solid orange
  }
  100% {
    opacity: 1;
    border: none
  }
}
@keyframes blink {
  50% {
    border-color: transparent
  }
}
@-webkit-keyframes blink {
  50% {
    border-color: tranparent
  }
}
</style>