Giter VIP home page Giter VIP logo

smccawille88 / shinyvalidator Goto Github PK

View Code? Open in Web Editor NEW

This project forked from novartis/shinyvalidator

0.0 0.0 0.0 10.35 MB

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

Home Page: http://opensource.nibr.com/shinyValidator/

License: Other

JavaScript 2.58% R 2.71% CSS 0.10% HTML 94.58% Dockerfile 0.04%

shinyvalidator's Introduction

shinyValidator

R-CMD-check Coverage

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:

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.

shinyvalidator's People

Contributors

divadnojnarg avatar kliatsko avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.