1
1
<!-- README.md is generated from README.Rmd. Please edit that file -->
2
- tidymodules <img src =" man/figures/logo.svg " align =" right " height =" 139 " />
3
- =========================================================================
4
2
5
- [ ![ Travis-CI build
6
- status] ( https://travis-ci.org/Novartis/tidymodules.svg?branch=master )] ( https://travis-ci.org/Novartis/tidymodules )
3
+ # tidymodules <img src =" man/figures/logo.svg " style =" float :right ; height :139px ;" />
4
+
5
+ [ ![ build
6
+ status] ( https://github.com/Novartis/tidymodules/actions/workflows/pkgdown.yaml/badge.svg )] ( https://github.com/Novartis/tidymodules/actions )
7
7
[ ![ lifecycle] ( https://img.shields.io/badge/lifecycle-experimental-orange.svg )] ( https://www.tidyverse.org/lifecycle/#experimental )
8
8
9
9
The ` {tidymodules} ` R package is built on top of shiny module using
@@ -31,51 +31,57 @@ Shiny modules are presented in the table below.
31
31
</thead >
32
32
<tbody >
33
33
<tr class =" odd " >
34
- <td ><a href =" articles/intro.html " ><i style =" color :#285fa4 ;" class =" fas fa-laptop-code fa-2x " ></i ></a ></td >
34
+ <td ><a
35
+ href="articles/intro.html"><i style =" color :#285fa4 ;" class =" fas fa-laptop-code fa-2x " ></i ></a ></td >
35
36
<td >Programming style</td >
36
37
<td >- <code >{R6}</code > OOP * <br /> - Semantic reference</td >
37
38
<td >Functional</td >
38
39
</tr >
39
40
<tr class =" even " >
40
- <td ><a href =" articles/namespace.html " ><i style =" color :#285fa4 ;" class =" fas fa-th-large fa-2x " ></i ></a ></td >
41
+ <td ><a
42
+ href="articles/namespace.html"><i style =" color :#285fa4 ;" class =" fas fa-th-large fa-2x " ></i ></a ></td >
41
43
<td >Namespace management</td >
42
44
<td >- automatic/generated <br /> - ID based lookup <br /> - Grouping</td >
43
45
<td >- manual management <br /> - must match between ui and server</td >
44
46
</tr >
45
47
<tr class =" odd " >
46
- <td ><a href =" articles/communication.html " ><i style =" color :#285fa4 ;" class =" fas fa-directions fa-2x " ></i ></a ></td >
48
+ <td ><a
49
+ href="articles/communication.html"><i style =" color :#285fa4 ;" class =" fas fa-directions fa-2x " ></i ></a ></td >
47
50
<td >Module communication</td >
48
- <td >- new module input/output port structure <br /> - module ports linked via tidy operators <br /> - automatic network diagram</td >
49
- <td >- parameter passing via module server() <br /> - challenging to manage for complex app</td >
51
+ <td >- new module input/output port structure <br /> - module ports linked
52
+ via tidy operators <br /> - automatic network diagram</td >
53
+ <td >- parameter passing via module server() <br /> - challenging to
54
+ manage for complex app</td >
50
55
</tr >
51
56
<tr class =" even " >
52
- <td ><a href =" articles/inheritance.html " ><i style =" color :#285fa4 ;" class =" fas fa-sitemap fa-2x " ></i ></a ></td >
57
+ <td ><a
58
+ href="articles/inheritance.html"><i style =" color :#285fa4 ;" class =" fas fa-sitemap fa-2x " ></i ></a ></td >
53
59
<td >Inheritance</td >
54
60
<td >- class inheritance <br /> - port inheritance for nested modules</td >
55
61
<td >NA</td >
56
62
</tr >
57
63
<tr class =" odd " >
58
- <td ><a href =" articles/session.html " ><i style =" color :#285fa4 ;" class =" fas fa-users fa-2x " ></i ></a ></td >
64
+ <td ><a
65
+ href="articles/session.html"><i style =" color :#285fa4 ;" class =" fas fa-users fa-2x " ></i ></a ></td >
59
66
<td >Session management</td >
60
- <td >- flexible user session management <br /> - Caching of modules coming soon</td >
67
+ <td >- flexible user session management <br /> - Caching of modules coming
68
+ soon</td >
61
69
<td >NA</td >
62
70
</tr >
63
71
</tbody >
64
72
</table >
65
73
66
74
\* OOP = Object Oriented Programming
67
75
68
- Installation
69
- ------------
76
+ ## Installation
70
77
71
78
You can install the most recent version of ` {tidymodules} ` from
72
79
[ GitHub] ( https://github.com/Novartis/tidymodules ) with:
73
80
74
81
library(devtools)
75
82
install_github("Novartis/tidymodules")
76
83
77
- Examples
78
- --------
84
+ ## Examples
79
85
80
86
You can quickly launch an example after installing the R package by
81
87
running the following.
@@ -93,8 +99,7 @@ Some examples have been deployed on shinyapp.io, such as:
93
99
- Example 4: [ Module communication
94
100
<i class =" fas fa-rocket " ></i >] ( https://tidymodules.shinyapps.io/4_communication/ )
95
101
96
- Learning More
97
- -------------
102
+ ## Learning More
98
103
99
104
Please review the [ Get
100
105
Started] ( https://opensource.nibr.com/tidymodules/articles/tidymodules.html )
@@ -104,15 +109,13 @@ developing Shiny apps.
104
109
If you are interested to develop modules using ` {tidymodules} ` , we
105
110
recommend reading the vignettes under “Articles”.
106
111
107
- Code of Conduct
108
- ---------------
112
+ ## Code of Conduct
109
113
110
114
Please note that the ` {tidymodules} ` is released with a [ Contributor
111
115
Code of Conduct] ( CODE_OF_CONDUCT.md ) . By contributing to this project,
112
116
you agree to abide by its terms.
113
117
114
- Acknowledgment
115
- --------------
118
+ ## Acknowledgment
116
119
117
120
- The SCC team members @ NVS for their valuable feedbacks
118
121
- 2019 Summer interns (Marzi, Stephen and Renan) for contributing to
@@ -122,8 +125,7 @@ Acknowledgment
122
125
[ e-poster] ( https://rpodcast.shinyapps.io/highlights-shiny ) @
123
126
rstudio::conf 2020
124
127
125
- Licence
126
- -------
128
+ ## Licence
127
129
128
130
Copyright 2020 Novartis AG
129
131
0 commit comments