shiny.info

Display simple diagnostic info of your Shiny app

https://github.com/appsilon/shiny.info

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.3%) to scientific vocabulary

Keywords

r rhinoverse shiny
Last synced: 9 months ago · JSON representation

Repository

Display simple diagnostic info of your Shiny app

Basic Info
Statistics
  • Stars: 61
  • Watchers: 27
  • Forks: 8
  • Open Issues: 5
  • Releases: 0
Topics
r rhinoverse shiny
Created over 7 years ago · Last pushed about 2 years ago
Metadata Files
Readme License

README.md

shiny.info Rhino logo

Display simple information of the shiny project in the user interface of the app.

CRAN
status R build
status Codecov test
coverage <!-- badges: end -->

How to install shiny.info?

You can install shiny.info from CRAN repository:

r install.packages("shiny.info")

You can get the most recent version from this repo using remotes.

r remotes::install_github("Appsilon/shiny.info")

How to use shiny.info?

Just add one of the shiny.info functions to the UI of your app (some features require also adding a little bit of code to the server function). Check features section and documentation for more details.

See live demo.

An example of a shiny app that uses shiny.info can be found in ./examples directory.

Basic features

  • display a simple text message:

r shiny.info::display("Hello user!", position = "top right")

  • show information about git branch, commit and changes:

r shiny.info::git_info()

  • add “powered by” information with link:

r shiny.info::powered_by("Appsilon", link = "appsilon.com")

  • show app version:

```r

global variable:

VERSION <- "1.2.2"

in app ui

shiny.info::version() ```

  • show a busy spinner when app is calculating:

r shiny.info::busy()

  • group multiple messages in one panel:

r shiny.info::info_panel( shiny.info::git_info(), shiny.info::powered_by("Appsilon", link = "appsilon.com"), position = "bottom left" )

Advanced features

  • render value (eg. input, reactive value) from the server:

```r

in app ui

shiny.info::infovalue("testinfo_value")

in app server

somevalue <- reactiveVal("a test value to display") output$testinfovalue <- shiny.info::renderinfovalue(somevalue()) ```

  • render information about the session:

```r

in app ui

shiny.info::infovalue("sessioninfo_value")

in app server

output$sessioninfovalue <- shiny.info::rendersessioninfo() ```

  • debug app using browser() function just by clicking a button:

```r

in app ui

shiny.info::inspectbtnui()

in app server

shiny.info::inspectbtnserver(input) ```

  • toggle display with a key shortcut:

r shiny.info::toggle_info("Ctrl+Shift+K")

  • show custom message using global variables:

```r

in app global

VERSION = "1.2.2" REPO = git2r::repositoryhead(repository("."))[[1]] GITCOMMITMESSAGE = git2r::commits(repository("."))[[1]]$message GITCOMMIT_HASH = git2r::commits(repository("."))[[1]]$sha

in app ui

shiny.info::display( message = glue("I am running on repository {REPO} from [{GITCOMMITHASH}]: {GITCOMMITMESSAGE}, and this is version: {VERSION}"), position = "top right", type = "custom_message" ) ```

  • show custom message using reactive variables:

```r

in app ui

shiny.info::infovalue("testinfo_value", position = "top right")

in app server

a <- reactive({ input$xcol rnorm(1,1) })

output$testinfovalue <- shiny.info::renderinfovalue( glue("a: {a()}, X Variable: {input$xcol}"), add_name = FALSE ) ```

How can I contribute?

If you want to contribute to this project please submit a regular PR once you’re done with your new feature or bug fix.

Appsilon

Appsilon is a Posit (formerly RStudio) Full Service Certified Partner.
Learn more at appsilon.com.

Get in touch opensource@appsilon.com

Explore the Rhinoverse - a family of R packages built around Rhino!

We are hiring!

Owner

  • Name: Appsilon
  • Login: Appsilon
  • Kind: organization
  • Email: hello@appsilon.com
  • Location: Warsaw, Poland

We're hiring! https://appsilon.com/careers

GitHub Events

Total
  • Member event: 1
Last Year
  • Member event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 161
  • Total Committers: 10
  • Avg Commits per committer: 16.1
  • Development Distribution Score (DDS): 0.522
Past Year
  • Commits: 6
  • Committers: 1
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jakub Nowicki k****a@a****m 77
Dominik Krzeminski (dokato) r****2@g****m 39
Marcin Dubel m****n@a****m 23
rabiibouhestine r****e@o****m 10
Pawel Przytula p****l@a****m 4
Renovate Bot b****t@r****m 3
dokato d****k@a****m 2
Paweł Przytuła p****l@a****l 1
whitesource-bolt-for-github[bot] 4****] 1
krzysztof-frappsilon k****f@a****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 16
  • Total pull requests: 48
  • Average time to close issues: 4 months
  • Average time to close pull requests: 3 months
  • Total issue authors: 9
  • Total pull request authors: 9
  • Average comments per issue: 0.44
  • Average comments per pull request: 0.67
  • Merged pull requests: 35
  • Bot issues: 3
  • Bot pull requests: 13
Past Year
  • Issues: 1
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jakubnowicki (6)
  • przytu1 (2)
  • mend-bolt-for-github[bot] (2)
  • wfma (1)
  • pawelru (1)
  • tomecki (1)
  • SaintRod (1)
  • renovate[bot] (1)
  • FractalPolarity (1)
Pull Request Authors
  • jakubnowicki (17)
  • renovate[bot] (12)
  • dokato (10)
  • rabiibouhestine (3)
  • mdubel (2)
  • sankhadeepdutta (1)
  • mend-bolt-for-github[bot] (1)
  • FractalPolarity (1)
  • jchojna (1)
Top Labels
Issue Labels
Priority: medium (2) Mend: dependency security vulnerability (2) Type: new feature (1) Effort: high (1) Difficulty: moderate (1) Status: to do (1) Type: maintenance (1) Effort: low (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 189 last-month
  • Total docker downloads: 194
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: shiny.info

'shiny' Info

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 189 Last month
  • Docker Downloads: 194
Rankings
Forks count: 3.8%
Stargazers count: 6.0%
Average: 21.6%
Dependent repos count: 24.3%
Dependent packages count: 27.9%
Downloads: 46.0%
Maintainers (1)
Last synced: 12 months ago

Dependencies

DESCRIPTION cran
  • git2r >= 0.22.1 imports
  • glue * imports
  • shiny * imports
  • covr * suggests
  • lintr * suggests
  • testthat * suggests
.github/workflows/main.yml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yml actions
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite