https://github.com/novartis/shinyvalidator

Audit your Shiny apps at each commit. Multiple levels of testings are offered: startup and crash tests, performance tests (load test and global code profiling), reactivity audit as well as output tests. All results are gathered in an HTML report uploaded and available to everyone on any CI/CD plaform or RStudio Connect
https://github.com/novartis/shinyvalidator

audit headless profiling r shiny shinyloadtest shinytest2

Last synced: 11 months ago
JSON representation

Audit your Shiny apps at each commit. Multiple levels of testings are offered: startup and crash tests, performance tests (load test and global code profiling), reactivity audit as well as output tests. All results are gathered in an HTML report uploaded and available to everyone on any CI/CD plaform or RStudio Connect

• Host: GitHub
• URL: https://github.com/novartis/shinyvalidator
• Owner: Novartis
• License: other
• Created: 2022-04-18T23:59:05.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-08-10T10:49:42.000Z (almost 3 years ago)
• Last Synced: 2025-05-06T03:38:52.989Z (about 1 year ago)
• Topics: audit, headless, profiling, r, shiny, shinyloadtest, shinytest2
• Language: HTML
• Homepage: http://opensource.nibr.com/shinyValidator/
• Size: 10.1 MB
• Stars: 42
• Watchers: 4
• Forks: 3
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# shinyValidator

[![R-CMD-check](https://github.com/Novartis/shinyValidator/workflows/R-CMD-check/badge.svg)](https://github.com/Novartis/shinyValidator/actions)

[![Coverage](https://img.shields.io/badge/Coverage-83%-yellowgreen)](https://github.com/Novartis/shinyValidator/tree/main/tests/testthat)

## Purpose

`{shinyValidator}` aims at __automating__ the audit of a Shiny App project's __quality__, particularly required during a __validation/qualification__ process. There are many different tools available to validate Shiny apps but, to the best of our knowledge, nothing has been made to get a global overview in a centralized report. 

By default, `{shinyValidator}`:

- Lints the code to ensure __consistency__ and quality.

- Runs a `devtools::check()` to assess package quality.

- Checks whether the Shiny app starts and is alive after heavy usage (requires headless browser solutions like `{shinytest2}`).

- Performs output comparison between commits (plot, htmlwidget). 

- Launches a load test to measure app __performance__ and identify bottlenecks (user concurrency, ...) with `{shinyloadtest}`.

- Records an overall code profiling with `{profvis}`.

- Audits reactivity with `{reactlog}`.

- Provides overview of project structure with `{flow}`. 

- Review all package dependencies against a locked environment (if provided) and show if versions are compliant.

Another goal of `{shinyValidator}` is to promote testing and automation (CI/CD) to deliver better Shiny apps in production. 

## Pre-requisites

- It must be run within a __package__ Shiny app project, compatible with `{golem}`. 

- It requires to control R package dependencies with `{renv}`.

## Installation

You can install the preview version of `{shinyValidator}` with:

``` r

remotes::install_github("Novartis/shinyValidator")

```

## Licence

Copyright 2022 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.