Skip to content

Commit

Permalink
fix logo style in pkgdown site
Browse files Browse the repository at this point in the history
  • Loading branch information
larbamu2 committed Feb 23, 2023
1 parent c1e2d57 commit daa948f
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 27 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ knitr::opts_chunk$set(
htmltools::tagList(rmarkdown::html_dependency_font_awesome())
```

# tidymodules <img src="man/figures/logo.svg" align="right" height="139" />
# tidymodules <img src="man/figures/logo.svg" style="float:right; height:139px;" />

[![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.
Expand Down
50 changes: 26 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- README.md is generated from README.Rmd. Please edit that file -->
tidymodules <img src="man/figures/logo.svg" align="right" height="139" />
=========================================================================

[![Travis-CI build
status](https://travis-ci.org/Novartis/tidymodules.svg?branch=master)](https://travis-ci.org/Novartis/tidymodules)
# tidymodules <img src="man/figures/logo.svg" style="float:right; height:139px;" />

[![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
Expand Down Expand Up @@ -31,51 +31,57 @@ Shiny modules are presented in the table below.
</thead>
<tbody>
<tr class="odd">
<td><a href="articles/intro.html"><i style="color:#285fa4;" class="fas fa-laptop-code fa-2x"></i></a></td>
<td><a
href="articles/intro.html"><i style="color:#285fa4;" class="fas fa-laptop-code fa-2x"></i></a></td>
<td>Programming style</td>
<td>- <code>{R6}</code> OOP * <br/> - Semantic reference</td>
<td>Functional</td>
</tr>
<tr class="even">
<td><a href="articles/namespace.html"><i style="color:#285fa4;" class="fas fa-th-large fa-2x"></i></a></td>
<td><a
href="articles/namespace.html"><i style="color:#285fa4;" class="fas fa-th-large fa-2x"></i></a></td>
<td>Namespace management</td>
<td>- automatic/generated <br/> - ID based lookup <br/> - Grouping</td>
<td>- manual management <br /> - must match between ui and server</td>
</tr>
<tr class="odd">
<td><a href="articles/communication.html"><i style="color:#285fa4;" class="fas fa-directions fa-2x"></i></a></td>
<td><a
href="articles/communication.html"><i style="color:#285fa4;" class="fas fa-directions fa-2x"></i></a></td>
<td>Module communication</td>
<td>- new module input/output port structure <br/> - module ports linked via tidy operators <br/> - automatic network diagram</td>
<td>- parameter passing via module server() <br/> - challenging to manage for complex app</td>
<td>- new module input/output port structure <br/> - module ports linked
via tidy operators <br/> - automatic network diagram</td>
<td>- parameter passing via module server() <br/> - challenging to
manage for complex app</td>
</tr>
<tr class="even">
<td><a href="articles/inheritance.html"><i style="color:#285fa4;" class="fas fa-sitemap fa-2x"></i></a></td>
<td><a
href="articles/inheritance.html"><i style="color:#285fa4;" class="fas fa-sitemap fa-2x"></i></a></td>
<td>Inheritance</td>
<td>- class inheritance <br/> - port inheritance for nested modules</td>
<td>NA</td>
</tr>
<tr class="odd">
<td><a href="articles/session.html"><i style="color:#285fa4;" class="fas fa-users fa-2x"></i></a></td>
<td><a
href="articles/session.html"><i style="color:#285fa4;" class="fas fa-users fa-2x"></i></a></td>
<td>Session management</td>
<td>- flexible user session management <br/> - Caching of modules coming soon</td>
<td>- flexible user session management <br/> - Caching of modules coming
soon</td>
<td>NA</td>
</tr>
</tbody>
</table>

\* OOP = Object Oriented Programming

Installation
------------
## Installation

You can install the most recent version of `{tidymodules}` from
[GitHub](https://github.com/Novartis/tidymodules) with:

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

Examples
--------
## Examples

You can quickly launch an example after installing the R package by
running the following.
Expand All @@ -93,8 +99,7 @@ Some examples have been deployed on shinyapp.io, such as:
- Example 4: [Module communication
<i class="fas fa-rocket"></i>](https://tidymodules.shinyapps.io/4_communication/)

Learning More
-------------
## Learning More

Please review the [Get
Started](https://opensource.nibr.com/tidymodules/articles/tidymodules.html)
Expand All @@ -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
Expand All @@ -122,8 +125,7 @@ Acknowledgment
[e-poster](https://rpodcast.shinyapps.io/highlights-shiny) @
rstudio::conf 2020

Licence
-------
## Licence

Copyright 2020 Novartis AG

Expand Down
2 changes: 1 addition & 1 deletion vignettes/tidymodules.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ knitr::opts_chunk$set(
)
```

## Overview
## Overview <img src="../man/figures/logo.svg" style="float:right; height:139px;" />

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:

Expand Down

0 comments on commit daa948f

Please sign in to comment.