forked from hypebright/shinyconf2024-shiny101
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathshiny101-modular-app-blueprint.qmd
1659 lines (1188 loc) · 37.6 KB
/
shiny101-modular-app-blueprint.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
title: "Shiny 101: The Modular App Blueprint"
author: "Veerle van Leemput"
format:
revealjs:
theme: [default, custom.scss]
footer: "[github.com/hypebright/shinyconf2024-shiny101](https://github.com/hypebright/shinyconf2024-shiny101)"
logo: images/logo.png
include-in-header:
text: |
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
highlight-style: "nord"
---
# Welcome 👋
# Getting to know each other ✨
## Program
- **19:30 - 20:00** Introduction to Shiny
- **20:00 - 20:30** Hands-on: Building a Shiny App Together
- **20:30 - 20:40** Break ☕️
- **20:40 - 21:00** Introduction to Shiny modules
- **21:00 - 21:40** Hands-on: Implementing Shiny modules
- **21:40 - 21:55** Sharing, Feedback + Questions
- **21:55 - 22:00** Recap
## Learning objectives
After this workshop, you will know:
- the basics of a Shiny application
- how to make your app modular
- how to communicate between modules
You will leave this workshop with:
- a blueprint for a modular Shiny app in the form of templates
# Introduction to Shiny
## Shiny app basics
Two parts of a Shiny app:
- **UI**: User Interface
- **Server**: Server logic
They come together in a single script: `app.R`
## The app.R script
```{.r code-line-numbers="1"}
library(shiny)
ui <- fluidPage(
"Hello, Shiny!"
)
server <- function(input, output, session) {
}
shinyApp(ui, server)
```
## The app.R script
```{.r code-line-numbers="3-5"}
library(shiny)
ui <- fluidPage(
"Hello, Shiny!"
)
server <- function(input, output, session) {
}
shinyApp(ui, server)
```
## The app.R script
```{.r code-line-numbers="7-8"}
library(shiny)
ui <- fluidPage(
"Hello, Shiny!"
)
server <- function(input, output, session) {
}
shinyApp(ui, server)
```
## The app.R script
```{.r code-line-numbers="10"}
library(shiny)
ui <- fluidPage(
"Hello, Shiny!"
)
server <- function(input, output, session) {
}
shinyApp(ui, server)
```
## The ui part
```{.r code-line-numbers="3-5"}
library(shiny)
ui <- fluidPage(
"Hello, Shiny!"
)
server <- function(input, output, session) {
}
shinyApp(ui, server)
```
`fluidPage()` creates a Bootstrap page
## The ui part
- Bootstrap is a free front-end framework used in web development and it includes all the basic to build an app that will work in a web browser on any device.
- It is built on **HTML**, **CSS** and **JavaScript**
- There are many version of Bootstrap, the latest being version 5, but Shiny uses version 3
## The ui part
Under the hood, every UI function is translated to HTML:
```{r}
library(shiny)
```
```{r}
#| echo: true
as.character(titlePanel("Hello, Shiny!"))
```
<br>
This HTML can have styles attached to it, either by the `style` attribute, or by a CSS class.
```{r}
#| echo: true
as.character(sidebarPanel())
```
## The ui part
To let users interact with your app, you can add **input controls**. A basic input control has:
- an `inputId`
- a `label`
- a `value`
## The ui part
For example:
```{.r}
numericInput(inputId = "number",
label = "Enter a number",
value = 0)
```
<br>
```{.r}
actionButton(inputId = "button",
label = "Click me")
```
## Updating the UI
When the app runs, every user gets served the same HTML from the ui.
When the user interacts with the UI, we want that HTML to **react** to the user.
The server logic uses **reactive programming**: when an input changes, all related outputs react and are updated automatically.
That is possible because these outputs are **reactive outputs**.
## Updating the UI
Shiny has several functions that turn R objects into reactive outputs for your ui: the *Output family
Each function creates a specific type of output, for example:
| UI Function | Output type |
|----------|-------------|
| textOutput() | text |
| tableOutput() | table |
| plotOutput() | plot |
| uiOutput() | raw HTML |
: {.table .table-striped .table-hover}
## Updating the UI
Every output element needs a single argument: `outputId`- which is a simple string that needs to be **unique**.
```{.r}
textOutput(outputId = "text")
```
This `textOutput `tells Shiny where to display the object. It's a **placeholder** for what's to come.
<br>
Next step: tell Shiny how to build the object!
## The server part
The server function builds an object named **output** and this object will contain all the code needed to display the R objects in the ui
This output object is **list-like**
Each R object that you want to display has its own entry in this list, therefore the name of every output in your ui needs to match a definition in the server
```{.r}
output$text
```
## The server part
Each entry in the output list should contain a render* function. You must use render* functions that match the *Output functions:
| UI Function | Output type | Render function |
|----------|-------------|-----------------|
| textOutput() | text | renderText() |
| tableOutput() | table | renderTable() |
| plotOutput() | plot | renderPlot() |
| uiOutput() | raw HTML | renderUI() |
: {.table .table-striped .table-hover}
## The server part
```{.r code-line-numbers="3,7-8"}
ui <- fluidPage(
textOutput(outputId = "text")
)
server <- function(input, output, session) {
output$text <- renderText({
})
}
```
## Using inputs
This works the same with inputs!
<br>
The server can access an object named `input` that will contain the value of all the input objects defined in the ui
<br>
This object is **list-like**, just like the output object. Each input value has its own entry in this list:
```{.r}
input$number
```
## Connecting the dots
If we combine the input and output objects, we can create a simple app that displays the square of a number 👏.
```{.r}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
output$text <- renderText({
input$number^2
})
}
shinyApp(ui, server)
```
:::footer
[/templates/00_base](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/00_base.R)
:::
## Connecting the dots
An output is **eager**: it will update as soon as the input changes.
<br>
This **eagerness** is handy: you don't need to worry about updating the output when the input changes.
<br>
But what if you want to trigger the calculation only when you want?
## Connecting the dots
You could use an `actionButton` as an **event**:
```{.r code-line-numbers="8-9,15-17"}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
}
shinyApp(ui, server)
```
:::footer
[/templates/01_start](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/01_start.R)
:::
## Observers
So far, we used render* function to take care of our output. It’s all happening inside the app.
<br>
But sometimes, we want to reach **outside the app**: call an API, send data to a database, send debugging messages. We want to call a function for its side-effects.
<br>
We need **observers** for that!
## Observers
Observers are functions that run when their dependencies change, just like outputs.
<br>
But where **outputs** update the HTML in the user's browser, observers are called for other **side-effects**.
<br>
For example 👉
## Observers
```{.r code-line-numbers="19-21"}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
observe({
print(input$number^2)
})
}
shinyApp(ui, server)
```
## Observers
```{.r code-line-numbers="21"}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
observe({
print(input$number^2)
}) |> bindEvent(input$button)
}
shinyApp(ui, server)
```
## What about reactives?
Outputs and observers **do** something: update the HTML, print something, call an API, you name it.
<br>
If we want to **create** something, we need **reactives**.
## What about reactives?
**Reactives** are functions that **return a value**. You can assign them to an object and you can refer to reactives elsewhere in your app.
<br>
You can see them as a backpack 🎒: they carry a value around and you can open it whenever you want.
## What about reactives?
When you go hiking, you pick a backpack that fits your needs. There are **different types** of backpacks that are fit **to carry different things**.
<br>
That's similar with a reactive. They carry different things:
- **reactive()**: takes an expression
- **reactiveVal()**: takes a single value
- **reactiveValues()**: takes a list of values
## What about reactives?
You can see `reactive()` as a very fancy backpack 🎒🌟.
<br>
It can take multiple inputs, manipulate them and return something simple (a value) or complex (a plot, a table). It can even take other reactives (other backpacks) as input!
## What about reactives?
```{.r code-line-numbers="15-17,20,24"}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
number_squared <- reactive({
input$number^2
}) |> bindEvent(input$button)
output$text <- renderText({
number_squared()
})
observe({
print(number_squared())
})
}
shinyApp(ui, server)
```
## What about reactives?
This fancy backpack is only opened when you ask for it. It is called **lazy**.
<br>
More technical: when the dependencies of a reactive change, it doesn't re-execute right away but rather waits until it gets called by someone else.
## And reactive values?
**reactive values** are simpler backpacks. They carry one or more value(s) that you can unpack, but also update.
<br>
You make a reactive value with `reactiveVal()` and you can update it by calling it with a new value.
<br>
You can make reactive values with `reactiveValues()` and you can update them by assigning a new value to them.
## And reactive values?
```{.r code-line-numbers="15,17-19,22,26"}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
number_squared <- reactiveVal(0)
observe({
number_squared(input$number^2)
}) |> bindEvent(input$button)
output$text <- renderText({
number_squared()
})
observe({
print(number_squared())
})
}
shinyApp(ui, server)
```
## And reactive values?
```{.r code-line-numbers="15,17-19,22,26"}
library(shiny)
ui <- fluidPage(
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
server <- function(input, output, session) {
r <- reactiveValues(number_squared = 0)
observe({
r$number_squared <- input$number^2
}) |> bindEvent(input$button)
output$text <- renderText({
r$number_squared
})
observe({
print(r$number_squared)
})
}
shinyApp(ui, server)
```
## And reactive values?
You can see `reactiveValues()` as some kind of reactive mini-database. You can use it to store multiple values, retrieve them in different places, and update them.
<br>
And since it's reactive, you can use it to **trigger other parts of your app** when one of its values changes.
<br>
Remember the `reactiveValues()` as we're going to use that later.
# And that covers the basic building blocks of your Shiny app 😮💨
## The hard part about Shiny
Note that the server part doesn't run line-by-line. It's a reactive environment that will run the code when input changes.
<br>
Code only reacts when it needs to, which is why it's called **reactive programming**.
<br>
This makes it hard to test your code. And it's hard to understand what's going on when you're new to Shiny!
## The hard part about Shiny
My personal top ways ways to get more insight into what's going on:
1. Use `print()` statements to see when something is happening
2. Use `browser()` to stop the code and inspect the environment (just as you can do within functions, because that is literally what `server` is!)
We're going to see these in action a little bit later.
# All about the looks 💅
## Quickly leveling up your UI
- There are many ways to make your app look instantly better
- One of them is using `bslib` which is a package that provides a modern UI toolkit for Shiny and R Markdown based on Bootstrap
- The cool thing: you can get around Shiny's default usage of Bootstrap version 3!
## Working with {bslib}
```{.r code-line-numbers="2,4-7"}
library(shiny)
library(bslib)
ui <- page_navbar(
theme = bs_theme(version = 5),
title = "Modular App Blueprint",
nav_panel(
title = "Numbers",
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me"),
textOutput(outputId = "text")
)
)
server <- function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
}
shinyApp(ui, server)
```
:::footer
[/templates/02_bslib](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/02_bslib.R)
:::
## Working with {bslib}
```{.r code-line-numbers="4-14,17"}
library(shiny)
library(bslib)
custom_theme <- bs_theme(
version = 5,
bg = "#F9F9F9",
fg = "#003f5c",
primary = "#bc5090",
secondary = "#58508d",
warning = "#ffa600",
danger = "#ff6361",
info = "#0091d5",
base_font = font_google("PT Sans")
)
ui <- page_navbar(
theme = custom_theme,
title = "Modular App Blueprint",
nav_panel(
title = "Numbers",
numericInput(inputId = "number",
label = "Enter a number",
value = 0),
actionButton(inputId = "button",
label = "Click me",
width = "100px"),
textOutput(outputId = "text")
)
)
server <- function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
}
shinyApp(ui, server)
```
:::footer
[/templates/02_bslib](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/02_bslib.R)
:::
## Shiny app recap
We covered:
- the ui & server part
- how to connect the two
- observers, reactives, reactive values, events
What's next?
- how to use some real data
- building your first Shiny app! 🚀
# Hands-on: building a Shiny app together 💻
## Steps
1. Head over to [github.com/hypebright/shinyconf2024-shiny101](https://github.com/hypebright/shinyconf2024-shiny101)
2. Fork the repository to your computer
3. Open **/templates/02_bslib.R**
4. Follow along!
<br>
Need help? David and me are here to help you out! 🚀
# Break ☕️
See you in [10 minutes](https://www.bigtimer.net/?minutes=10&repeat=false)
# Shiny modules ⚙️
## What are modules?
You could call modules **special functions**.
<br>
Using functions in a Shiny app is common:
- You use functions in your UI (e.g. `value_box()`)
- You use functions in your server
<br>
That works well for code that is **completely on the ui or server side**.
## What are modules?
For code that spans both the ui and the server, you need a new technique: **modules**
<br>
A module consists of some **UI code** that works together with some **server code**
<br>
Modules are special because they create their own **namespace**: things like input and output ids are isolated from the rest of the app
## Why use modules?
There are two main reasons to work with modules:
<br>
1. Because a module creates its own **namespace**, you can write and run code in isolation. You don’t need to worry about what’s going on outside the module. And remember, ids needed to be unique!
2. Because a module is basically a **function**, it comes with all the benefits that functions have.
## What does a module look like?
A module has two parts, and is basically a mini-app:
<br>
1. **The module UI**, which generates the HTML and runs code inside the `ui()` function
2. **The module server**, which runs code inside the `server()` function
## What does a module look like?
```{.r code-line-numbers="3-13"}
library(shiny)
numberModUI <- function(id) {
ns <- NS(id)
tagList(
numericInput(inputId = ns("number"),
label = "Enter a number",
value = 0),
actionButton(inputId = ns("button"),
label = "Click me"),
textOutput(outputId = ns("text"))
)
}
numberModServer <- function(id) {
moduleServer(id, function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
})
}
ui <- fluidPage(
numberModUI("numbers")
)
server <- function(input, output, session) {
numberModServer("numbers")
}
shinyApp(ui, server)
```
:::footer
[/templates/03_modules](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/03_modules.R)
:::
## What does a module look like?
```{.r code-line-numbers="3,4,6,9,11"}
library(shiny)
numberModUI <- function(id) {
ns <- NS(id)
tagList(
numericInput(inputId = ns("number"),
label = "Enter a number",
value = 0),
actionButton(inputId = ns("button"),
label = "Click me"),
textOutput(outputId = ns("text"))
)
}
numberModServer <- function(id) {
moduleServer(id, function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
})
}
ui <- fluidPage(
numberModUI("numbers")
)
server <- function(input, output, session) {
numberModServer("numbers")
}
shinyApp(ui, server)
```
:::footer
[/templates/03_modules](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/03_modules.R)
:::
## What does a module look like?
```{.r code-line-numbers="15-21"}
library(shiny)
numberModUI <- function(id) {
ns <- NS(id)
tagList(
numericInput(inputId = ns("number"),
label = "Enter a number",
value = 0),
actionButton(inputId = ns("button"),
label = "Click me"),
textOutput(outputId = ns("text"))
)
}
numberModServer <- function(id) {
moduleServer(id, function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
})
}
ui <- fluidPage(
numberModUI("numbers")
)
server <- function(input, output, session) {
numberModServer("numbers")
}
shinyApp(ui, server)
```
:::footer
[/templates/03_modules](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/03_modules.R)
:::
## What does a module look like?
```{.r code-line-numbers="23-29"}
library(shiny)
numberModUI <- function(id) {
ns <- NS(id)
tagList(
numericInput(inputId = ns("number"),
label = "Enter a number",
value = 0),
actionButton(inputId = ns("button"),
label = "Click me"),
textOutput(outputId = ns("text"))
)
}
numberModServer <- function(id) {
moduleServer(id, function(input, output, session) {
output$text <- renderText({
input$number^2
}) |> bindEvent(input$button)
})
}
ui <- fluidPage(
numberModUI("numbers")
)
server <- function(input, output, session) {
numberModServer("numbers")
}
shinyApp(ui, server)
```
:::footer
[/templates/03_modules](https://github.com/hypebright/shinyconf2024-shiny101/blob/main/templates/03_modules.R)
:::
## Where do you put modules?
You can simple put the module functions in the `app.R` file (you call this **inline**).
<br>
Other options:
- Put the module in a separate R script in the /R folder. **Shiny will automatically source it**.
- Put the module in a separate R script in any other folder, and source it using `source(“./my_modules/random.R”)`.
## Nested modules
Modules are **composable**, and it may make sense to create a module that itself contains a module: this is called **nesting**
<br>
This sounds complicated, but isn’t any different compared to calling a function within another function
## Nested modules
```{.r code-line-numbers="38-53"}
library(shiny)
library(bslib)
library(DT)
custom_theme <- bs_theme(
version = 5,
# for themes see: https://bootswatch.com
preset = "quartz",
base_font = font_google("PT Sans")
)
# module 1 -------------------------------------------------------
numberModUI <- function(id) {
ns <- NS(id)
tagList(
numericInput(inputId = ns("number"),
label = "Enter a number",
value = 0),
actionButton(inputId = ns("button"),