diff --git a/README.Rmd b/README.Rmd
index 4bcf15c..d43e247 100644
--- a/README.Rmd
+++ b/README.Rmd
@@ -18,9 +18,9 @@ knitr::opts_chunk$set(
htmltools::tagList(rmarkdown::html_dependency_font_awesome())
```
-# tidymodules
+# tidymodules
-[![Travis-CI build status](https://travis-ci.org/Novartis/tidymodules.svg?branch=master)](https://travis-ci.org/Novartis/tidymodules)
+[![build status](https://github.com/Novartis/tidymodules/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/Novartis/tidymodules/actions)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
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.
diff --git a/README.md b/README.md
index 48f0de3..ae6acce 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
-tidymodules
-=========================================================================
-[![Travis-CI build
-status](https://travis-ci.org/Novartis/tidymodules.svg?branch=master)](https://travis-ci.org/Novartis/tidymodules)
+# tidymodules
+
+[![build
+status](https://github.com/Novartis/tidymodules/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/Novartis/tidymodules/actions)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
The `{tidymodules}` R package is built on top of shiny module using
@@ -31,33 +31,41 @@ Shiny modules are presented in the table below.
- |
+ |
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 |
+- 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 |
+- flexible user session management - Caching of modules coming
+soon |
NA |
@@ -65,8 +73,7 @@ Shiny modules are presented in the table below.
\* OOP = Object Oriented Programming
-Installation
-------------
+## Installation
You can install the most recent version of `{tidymodules}` from
[GitHub](https://github.com/Novartis/tidymodules) with:
@@ -74,8 +81,7 @@ You can install the most recent version of `{tidymodules}` from
library(devtools)
install_github("Novartis/tidymodules")
-Examples
---------
+## Examples
You can quickly launch an example after installing the R package by
running the following.
@@ -93,8 +99,7 @@ Some examples have been deployed on shinyapp.io, such as:
- Example 4: [Module communication
](https://tidymodules.shinyapps.io/4_communication/)
-Learning More
--------------
+## Learning More
Please review the [Get
Started](https://opensource.nibr.com/tidymodules/articles/tidymodules.html)
@@ -104,15 +109,13 @@ developing Shiny apps.
If you are interested to develop modules using `{tidymodules}`, we
recommend reading the vignettes under “Articles”.
-Code of Conduct
----------------
+## Code of Conduct
Please note that the `{tidymodules}` is released with a [Contributor
Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project,
you agree to abide by its terms.
-Acknowledgment
---------------
+## Acknowledgment
- The SCC team members @ NVS for their valuable feedbacks
- 2019 Summer interns (Marzi, Stephen and Renan) for contributing to
@@ -122,8 +125,7 @@ Acknowledgment
[e-poster](https://rpodcast.shinyapps.io/highlights-shiny) @
rstudio::conf 2020
-Licence
--------
+## Licence
Copyright 2020 Novartis AG
diff --git a/vignettes/tidymodules.Rmd b/vignettes/tidymodules.Rmd
index 412282f..0729356 100644
--- a/vignettes/tidymodules.Rmd
+++ b/vignettes/tidymodules.Rmd
@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
)
```
-## Overview
+## Overview
This vignette aims to provide a high level introduction to tidymodules. We recommend reading this article for anyone who is new to tidymodules, especially those tidymodules module "consumers", who use existing module classes as a "black-box" in their Shiny app development. This article includes the following topics: