「ShinyModule」で中規模Shinyアプリをキレイにする

R Shiny

こんにちは。今日はShiny力を高める記事です。

Shinyは便利ですが、だんだん規模が大きくなったときに、どうコードを書けば良いのか悩みます。 そこで今回は、Shinyコードが多くなってきたときに便利な機能 「ShinyModule」 について説明します。

ShinyModuleとは

概要

ShinyModuleとは、大きくなったShinyアプリを見通しよく書くための機能で、バージョン0.13.0から追加されました 。 その概念を大雑把に述べると、ちっちゃなShinyアプリのようなものです。 大きなShinyアプリから切り出して、関心ごとのShinyアプリ（のようなもの）に分けたのがShiny Moduleというイメージです。

小さなShinyModuleを組み合わせて大きなShinyアプリをつくることで、見通しよいコードとなります。

何が嬉しいのか

ShinyModuleは関数のように再利用することができます。そのため、似たようなパーツを複数持つShinyアプリを作る際に、似たようなコードをコピペせずに済みます。 複数タブで似たようなページを持つアプリで特に便利です。

ここまで聞くと「関数で良いだろ」と思うかもしれませんが、よりShinyに特化したものがShinyModuleというイメージですかね。

一番うれしいのは、名前空間をいい感じに管理してくれることです。

名前空間がやばい

みなさんは、Shinyアプリを作っていて、input・outputのIDが被りそうになった経験はありませんか？ 例えば、複数のグラフを載せるアプリの場合、outputのIDを output$result1_plot , output$result2_plot , output$result3_plot ... として、管理が大変になったり。 さらに、各プロットの平均も載せようとして、 output$result1_mean , output$result2_mean , output$result3_mean ... としてしまうと、ますます混乱していきます。

そんなときこそ、ShinyModuleを使うときです。 まず、server.RからModuleとして切り離し、そのModuleの中で output$plot , output$mean という名前でserver側の処理を書きます。 次に、同様にui部分でもModuleとして切り離し、各グラフを識別する ID （この場合、 result1 , result2 , result3 ... ）を記載するだけでOKです。 これだけで、result1 を渡したときは、アプリ全体の中では output$result1-plot , output$result1-mean として認識されるようになります。

書き方

基本

説明だけではイメージしにくいと思うので、実際に書いてみましょう。

ShinyModuleは、次のような型式で書きます。

# UI
irisPlotUI <- function(){ # UI }

# Server
irisPlot <- function(){ # Serverロジック }

UI部分のModuleとServer部分のModuleが必要で、UI側は末尾が Input , Output , UI のいずれかでなければなりません。 Server側はそれらの末尾文字列を消したものと同名である必要があります。

実例 〜 改修前 〜

では、これを踏まえ、irisデータのヒストグラムを作るShinyアプリを書いてみます。こんな感じです。

f:id:ksmzn:20180124215219p:plain

上側にPetal, 下側にSepalの、それぞれ Length か Width のヒストグラムを表示するアプリです。

ShinyModuleを使わずに素直に書くと、次のようなコードになりました。

# No Shiny Module
library(shiny)

ui <- fluidPage(
  selectInput('petal_col', '列：', c('Petal.Length', 'Petal.Width')),
  plotOutput('petal_plot'),
  selectInput('sepal_col', '列：', c('Sepal.Length', 'Sepal.Width')),
  plotOutput('sepal_plot')
)
server <- function(input, output, session) {
  output$petal_plot <- renderPlot({
    hist(iris[, input$petal_col])
  }) 
  output$sepal_plot <- renderPlot({
    hist(iris[, input$sepal_col])
  }) 
}

shinyApp(ui, server)

このくらいならわかりやすいですが、ui, serverそれぞれで、コピペしてしまっている箇所がありますね。 さらにプロットを増やしたくなると、煩雑なコードになるのが目に見えています。

これを、ShinyModuleを使って綺麗にしましょう。

Module UI

ShinyModule のUI側は、次のように書きます。

irisPlotUI <- function(id, cols) {
  ns <- NS(id)

  tagList(
    selectInput(ns('col'), '列：', cols),
    plotOutput(ns('plot'))
  )
}

id, colsを引数にとり、何らかのアウトプット（この場合はselectInputとプロット）を返します。 ShinyModuleの書き方のルールとして、第一引数は必ず id です。これが名前を識別するためのidとなります。 第二引数以降は、各Moduleで必要なものを追加できます。 この場合、selectInputに必要な選択肢として、cols を使うので追加しました。

通常のShinyと違うのは、NS の部分です。

NS 関数は、識別するための文字列を渡すと、Namespace（名前空間）を管理してくれる関数を返します。

> ns <- shiny::NS('result1')
> ns('plot')
[1] "result1-plot"

名前空間を管理といっても、識別文字列を先頭に追加するだけです。 単純ですが、これを使って名前が被らないようにしています。

Module Server

次に、これに対応するServer側の書き方を見てみましょう。

irisPlot <- function(input, output, session, main){
  output$plot <- renderPlot({
    hist(iris[, input$col], main = main)
  }) 
}

input, output, sessionを引数にとるところまでは、通常のShinyのserverと同じです。 さらに、追加引数として、そのmodule特有の引数をとることもできます。 この場合、ヒストグラムのタイトルとして main という引数を追加しています。

お気づきのとおり、単純にoutputのIDを plot と書くことができます。 ShinyModuleを使わない例のように、わざわざ output$petal-plot , output$sepal-plot などと書き分ける必要がありません。 便利ですね。

Module を組み込む

では、これらのModuleを、ui, serverに組み込みましょう。

まず、uiは次のように書きます。

ui <- fluidPage(
  irisPlotUI('petal', c('Petal.Length', 'Petal.Width')),
  irisPlotUI('sepal', c('Sepal.Length', 'Sepal.Width'))
)

単純に irisPlotUI を呼び出し、id と 選択肢を引数として渡します。 このidが、それぞれのModuleの間で識別するために使われます。

次に、server側です。

server <- function(input, output, session) {
  callModule(irisPlot, "petal", "Petal Plot")
  callModule(irisPlot, "sepal", "Sepal Plot")
}

server側の書き方は、少し特殊です。 callModule 関数の第一引数に Module名、第二引数にid, 第三引数以降にはそのModuleで必要なものを渡します。

実例 〜 改修後 〜

以上で改修終了です。最終的にこのようなコードになりました。

# Shiny Module
library(shiny)

irisPlotUI <- function(id, cols){
  ns <- NS(id)
  tagList(
    selectInput(ns('col'), '列：', cols),
    plotOutput(ns('plot'))
  )
}
irisPlot <- function(input, output, session, main){
  output$plot <- renderPlot({
    hist(iris[, input$col], main = main)
  }) 
}

ui <- fluidPage(
  irisPlotUI('petal', c('Petal.Length', 'Petal.Width')),
  irisPlotUI('sepal', c('Sepal.Length', 'Sepal.Width'))
)
server <- function(input, output, session) {
  callModule(irisPlot, "petal", "Petal Plot")
  callModule(irisPlot, "sepal", "Sepal Plot")
}

shinyApp(ui, server)

行数さえ増えたものの、見通しがよくなりました。

コアの機能部分が独立したModuleになっているので、ui, server内で無駄なコピペが減っています。 もっとプロットを増やしたくなっても、簡単に修正可能です。 さらに、名前管理も自前でやる部分が少なくなり、心理的負担も減りました。

終わりに

ShinyModuleによる見通しのよい書き方をご説明しました。 いきなりShinyModuleを使う必要はありませんが、アプリが大きくなり、処理を関数に分けたくなったときに検討する価値はあります。

僕が運営している 「ShinyDistributionsApp」 というアプリでは、ShinyModule部分を module.R という別のRファイルに書き、global.Rの中から読み込むようにしています。 こうすると、ui.R, server.Rが簡潔になるのでオススメです。 特にShinyDashboardを使う場合はui.R, server.Rが長くなりがちなので、是非試してみてください。 コードは こちら です。

参考文献