{"id":13736675,"url":"https://github.com/Novartis/tidymodules","last_synced_at":"2025-05-08T12:33:30.776Z","repository":{"id":59985598,"uuid":"203401748","full_name":"Novartis/tidymodules","owner":"Novartis","description":"An Object-Oriented approach to Shiny modules ","archived":false,"fork":false,"pushed_at":"2024-07-18T08:00:24.000Z","size":1442,"stargazers_count":143,"open_issues_count":25,"forks_count":11,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-08-04T03:06:54.353Z","etag":null,"topics":["communication","inheritance","oop","r","shiny","shiny-modules","tidy-operators"],"latest_commit_sha":null,"homepage":"https://opensource.nibr.com/tidymodules","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Novartis.png","metadata":{"files":{"readme":"README.Rmd","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-08-20T15:16:40.000Z","updated_at":"2024-07-17T08:11:37.000Z","dependencies_parsed_at":"2024-02-06T05:50:48.912Z","dependency_job_id":null,"html_url":"https://github.com/Novartis/tidymodules","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Novartis%2Ftidymodules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Novartis%2Ftidymodules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Novartis%2Ftidymodules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Novartis%2Ftidymodules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Novartis","download_url":"https://codeload.github.com/Novartis/tidymodules/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224732129,"owners_count":17360416,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["communication","inheritance","oop","r","shiny","shiny-modules","tidy-operators"],"created_at":"2024-08-03T03:01:26.335Z","updated_at":"2024-11-15T04:32:16.018Z","avatar_url":"https://github.com/Novartis.png","language":"R","readme":"---\noutput: md_document\nalways_allow_html: yes\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r setup, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n```{r, include=FALSE}\nhtmltools::tagList(rmarkdown::html_dependency_font_awesome())\n```\n\n# tidymodules \u003cimg src=\"man/figures/logo.svg\" style=\"float:right; height:139px;\" /\u003e\n\n[![build status](https://github.com/Novartis/tidymodules/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/Novartis/tidymodules/actions)\n[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)\n\nThe `{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. \n\nThe main features of tidymodules and its comparison with conventional Shiny modules are presented in the table below.\n\n| Features |              | tidymodules                                                                                                               | Conventional modules                                                                  |\n|----|----------------------|---------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [\u003ci style=\"color:#285fa4;\" class=\"fas fa-laptop-code fa-2x\"\u003e\u003c/i\u003e](articles/intro.html) | Programming style    | - `{R6}` OOP * \u003cbr/\u003e - Semantic reference                                                                                       | Functional                                                                            |\n| [\u003ci style=\"color:#285fa4;\" class=\"fas fa-th-large fa-2x\"\u003e\u003c/i\u003e](articles/namespace.html) | Namespace management | - automatic/generated \u003cbr/\u003e - ID based lookup \u003cbr/\u003e - Grouping                                                                             | - manual management \u003cbr /\u003e - must match between ui and server                         |\n| [\u003ci style=\"color:#285fa4;\" class=\"fas fa-directions fa-2x\"\u003e\u003c/i\u003e](articles/communication.html) | Module communication | - new module input/output port structure \u003cbr/\u003e - module ports linked via tidy operators \u003cbr/\u003e - automatic network diagram | - parameter passing via module server() \u003cbr/\u003e - challenging to manage for complex app |\n| [\u003ci style=\"color:#285fa4;\" class=\"fas fa-sitemap fa-2x\"\u003e\u003c/i\u003e](articles/inheritance.html) | Inheritance          | - class inheritance \u003cbr/\u003e - port inheritance for nested modules                                                           | NA                                                                                    |\n| [\u003ci style=\"color:#285fa4;\" class=\"fas fa-users fa-2x\"\u003e\u003c/i\u003e](articles/session.html) | Session management   | - flexible user session management \u003cbr/\u003e - Caching of modules coming soon                                                             | NA                                                                                    |\n\n\\* OOP = Object Oriented Programming\n\n## Installation\n\nYou can install the most recent version of `{tidymodules}` from [GitHub](https://github.com/Novartis/tidymodules) with:\n\n``` r\nlibrary(devtools)\ninstall_github(\"Novartis/tidymodules\")\n```\n\n## Examples\n\nYou can quickly launch an example after installing the R package by running the following.\n``` r\ntidymodules::showExamples(4)\n```\nSome examples have been deployed on shinyapp.io, such as: \n\n- Example 1: [Simple addition \u003ci class=\"fas fa-rocket\"\u003e\u003c/i\u003e](https://tidymodules.shinyapps.io/1_simple_addition/)\n- Example 2: [Linked scatter \u003ci class=\"fas fa-rocket\"\u003e\u003c/i\u003e](https://tidymodules.shinyapps.io/2_linked_scatter/)\n- Example 2: [Nested module \u003ci class=\"fas fa-rocket\"\u003e\u003c/i\u003e](https://tidymodules.shinyapps.io/3_nested_modules/)\n- Example 4: [Module communication \u003ci class=\"fas fa-rocket\"\u003e\u003c/i\u003e](https://tidymodules.shinyapps.io/4_communication/)\n\n## Learning More\n\nPlease review the [Get Started](https://opensource.nibr.com/tidymodules/articles/tidymodules.html) page for a high level introduction to `{tidymodules}` and its usage in developing Shiny apps.\n\nIf you are interested to develop modules using `{tidymodules}`, we recommend reading the vignettes under \"Articles\".\n\n## Code of Conduct\n\nPlease 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.\n\n## Acknowledgment\n\n- The SCC team members @ NVS for their valuable feedbacks\n- 2019 Summer interns (Marzi, Stephen and Renan) for contributing to testing the framework and implementing the demo example 4 listed above.\n- Eric Nantz for accepting to introduce tidymodules in his [e-poster](https://rpodcast.shinyapps.io/highlights-shiny) @ rstudio::conf 2020\n\n## Licence\n\n    Copyright 2020 Novartis AG\n\n    Licensed under the Apache License, Version 2.0 (the \"License\");\n    you may not use this file except in compliance with the License.\n    You may obtain a copy of the License at\n\n      http://www.apache.org/licenses/LICENSE-2.0\n\n    Unless required by applicable law or agreed to in writing, software\n    distributed under the License is distributed on an \"AS IS\" BASIS,\n    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n    See the License for the specific language governing permissions and\n    limitations under the License.\n","funding_links":[],"categories":["Ranked by starred repositories","Developer Tools","R"],"sub_categories":["Modularization"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNovartis%2Ftidymodules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FNovartis%2Ftidymodules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FNovartis%2Ftidymodules/lists"}