i2dash

i2dash: interactive and iterative dashboards.

https://github.com/loosolab/i2dash

Science Score: 23.0%

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

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 2 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    6 of 6 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.1%) to scientific vocabulary

Keywords

i2dash
Last synced: 11 months ago · JSON representation

Repository

i2dash: interactive and iterative dashboards.

Basic Info
Statistics
  • Stars: 10
  • Watchers: 4
  • Forks: 3
  • Open Issues: 3
  • Releases: 0
Topics
i2dash
Created over 6 years ago · Last pushed almost 3 years ago
Metadata Files
Readme License

README.md

Interactive & iterative dashboards in R

Abstract

Scientific communication and data visualization are important aspects to illustrate complex concepts and results from data analyses. The R package i2dash provides functionality to create customized, web-based dashboards for data presentation, exploration and sharing. i2dash integrates easily into existing data analysis pipelines and can organize scientific findings thematically across different pages and layouts. Ultimately, i2dash supports a wide range of R objects (e.g. 'htmlwidgets') and custom content generating functions as input and therefore integrates well into existing data analysis pipelines.

Main features

  • Easy integration into existing analysis pipelines in R for programmatic dashboard creation
  • Provides a selection of predefined layouts to arrange content
  • Support for multiple components, such as htmlwidgets, tables, text, images etc.
  • Creation of web-based, sharable, static or interactive dashboards
  • Enables a flexible and iterative cycle of dashboard development

(A) dashboard is initialized at the beginning of a data analysis pipeline. During the pipeline run, new content, results, or data visualizations are iteratively added to the dashboard’s pages. The final dashboard is rendered into a static or interactive document. (B) Pages added to the dashboard can be arranged in a flexible manner from a selection of predefined layouts. (C) Examples of programmatically created dashboards. (D) The i2dash docker container, providing all dependencies for interactive, shiny based apps, can be used to easily deploy individual data interpretations on a cloud infrastructure, such as Kubernetes, as a micro service.

Installation

The package can be installed with:

install.packages("i2dash")

Where to start

  • Basics This tutorial gives on overview over the core functions of i2dash and explains how you can build your first dashboard.

  • Custom extension This tutorial teaches how to create custumized and reusable components for i2dash

Extension

It is possible to extend the core functionality of i2dash with templates for components and pre-defined pages. This enables to provide an enhanced user interactivity e.g. dynamic change of plot settings. Further, extensions allow an easier integration of complex calculations and data manipulation, hidden behind functions.

  • i2dash.scrnaseq enables an enhanced user interactivity and contains simple but effective tools for the creation of an i2dashboard with focus on single-cell RNA-sequencing data visualization and exploration.

Run i2dash using Docker

At first, install Docker. Then pull the image of i2dash:

docker pull docker.gitlab.gwdg.de/loosolab/container/i2dash.deployment:r3.6.3_bioc3.10

The next step is to run a container and simultaneously load the dashboard files (the .Rmd file and all files of the datadir(dashboard) directory) into the container. To mount custom data into the container, make use of Docker's -v parameter to mount a host directory into the container. Inside the container, i2dash looks for external datasets in /srv/shiny-server/. Use the following code, where you exchange /path/to/dashboard/files with the respective path to the directory containing the .Rmd file and all files of the datadir(dashboard) directory.

docker run -d -p 3838:3838 -v '/path/to/dashboard/files':'/srv/shiny-server' docker.gitlab.gwdg.de/loosolab/container/i2dash.deployment:r3.6.3_bioc3.10

Now, view the dashboard with your browser at 3838:3838.

How to cite

If you use i2dash or i2dash.scrnaseq in your work, please cite:

i2dash: Creation of Flexible, Interactive and Web-based Dashboards for Visualization of Omics-pipeline Results Arsenij Ustjanzew, Jens Preussner, Mette Bentsen, Carsten Kuenne, Mario Looso bioRxiv 2020.07.06.189563; doi: https://doi.org/10.1101/2020.07.06.189563

License

This project is licensed under the MIT license.

FAQ

  • The Rmd file of the dashboard contains pages and components but after rendering the dashboard remains empty: Make sure you have a current version of pandoc installed and view the dashboard only with a modern browser.

Owner

  • Name: Looso bioinformatics lab
  • Login: loosolab
  • Kind: organization
  • Location: Bad Nauheim, Germany

Group of bioinformatics at the Max Planck Institute for Heart and Lung Research

GitHub Events

Total
Last Year

Committers

Last synced: over 3 years ago

All Time
  • Total Commits: 100
  • Total Committers: 6
  • Avg Commits per committer: 16.667
  • Development Distribution Score (DDS): 0.47
Top Committers
Name Email Commits
Jens Preussner j****r@m****e 53
arsenij.ustjanzew a****w@m****e 27
Arsenij Ustjanzew A****w@m****e 10
Ustjanzew a****z@U****e 6
Ustjanzew a****n@k****e 3
Arsenij Ustjanzew a****w@u****e 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: almost 3 years ago

All Time
  • Total issues: 5
  • Total pull requests: 4
  • Average time to close issues: 5 months
  • Average time to close pull requests: 2 days
  • Total issue authors: 4
  • Total pull request authors: 2
  • Average comments per issue: 2.2
  • Average comments per pull request: 0.25
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Agpa88 (2)
  • SaiRaj07 (1)
  • systemnova (1)
  • ashishjain1988 (1)
Pull Request Authors
  • arsenij-ust (3)
  • jenzopr (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 270 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 5
  • Total maintainers: 1
cran.r-project.org: i2dash

Iterative and Interactive Dashboards

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 270 Last month
Rankings
Forks count: 14.3%
Stargazers count: 16.5%
Dependent repos count: 24.2%
Average: 26.9%
Dependent packages count: 29.0%
Downloads: 50.6%
Maintainers (1)
Last synced: over 2 years ago

Dependencies

DESCRIPTION cran
  • assertive.sets * imports
  • assertive.types * imports
  • flexdashboard * imports
  • glue * imports
  • htmltools * imports
  • knitr * imports
  • magrittr * imports
  • methods * imports
  • rmarkdown * imports
  • stats * imports
  • stringi * imports
  • stringr * imports
  • utils * imports
  • xfun * imports
  • ymlthis * imports
  • BiocStyle * suggests
  • ComplexHeatmap * suggests
  • digest * suggests
  • forcats * suggests
  • ggplot2 * suggests
  • gt * suggests
  • kableExtra * suggests
  • leaflet * suggests
  • plotly * suggests
  • switchr * suggests
  • testthat * suggests
.ci/requirements.txt pypi
  • bioconductor-biocstyle *
  • qpdf *
  • r-assertive.sets *
  • r-assertive.types *
  • r-base =3.6.3
  • r-flexdashboard *
  • r-ggplot2 *
  • r-glue *
  • r-htmltools *
  • r-knitr *
  • r-leaflet *
  • r-magrittr *
  • r-plotly *
  • r-stringi *
  • r-stringr *
  • r-yaml *
  • r-ymlthis *
  • zip *