" class="reference-link">tidymodules

The {tidymodules} R package is built on top of shiny module using
{R6} to provide a new object-oriented programming (OOP) approach for
module development, new module interface using input/output ports and a
set of tidy operators for handling cross-module communication.

The main features of tidymodules and its comparison with conventional
Shiny modules are presented in the table below.

	tidymodules	Conventional modules
Programming style	- `{R6}` OOP * - Semantic reference	Functional
Namespace management	- automatic/generated - ID based lookup - Grouping	- manual management - must match between ui and server
Module communication	- new module input/output port structure - module ports linked via tidy operators - automatic network diagram	- parameter passing via module server() - challenging to manage for complex app
Inheritance	- class inheritance - port inheritance for nested modules	NA
Session management	- flexible user session management - Caching of modules coming soon	NA

* OOP = Object Oriented Programming

Installation

You can install the most recent version of {tidymodules} from
GitHub with:

library(devtools)
install_github("Novartis/tidymodules")

Examples

You can quickly launch an example after installing the R package by
running the following.

tidymodules::showExamples(4)

Some examples have been deployed on shinyapp.io, such as:

Example 1: Simple addition
Example 2: Linked scatter
Example 2: Nested module
Example 4: Module communication

Learning More

Please review the Get
Started
page for a high level introduction to {tidymodules} and its usage in
developing Shiny apps.

If you are interested to develop modules using {tidymodules}, we
recommend reading the vignettes under “Articles”.

Code of Conduct

Please note that the {tidymodules} is released with a Contributor
Code of Conduct. By contributing to this project,
you agree to abide by its terms.

Acknowledgment

The SCC team members @ NVS for their valuable feedbacks
2019 Summer interns (Marzi, Stephen and Renan) for contributing to
testing the framework and implementing the demo example 4 listed
above.
Eric Nantz for accepting to introduce tidymodules in his
e-poster @
rstudio::conf 2020

Licence

Copyright 2020 Novartis AG
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.