Skip to content
Snippets Groups Projects
Commit 4da1e1cb authored by jens.preussner's avatar jens.preussner :ghost:
Browse files

Merge branch 'patch-1' into 'master'

Update README.md

See merge request !13
parents de6d563b abff1f45
No related branches found
No related tags found
1 merge request!13Update README.md
Pipeline #130583 passed
# **i2dash**: - **I**nteractive & **i**terative **dash**boards in R <img src="man/figures/i2dash_logo.png" align="right" width="150px"/> # **i2dash**: - **I**nteractive & **i**terative **dash**boards in R <img src="vignettes/images/i2dash_logo.png" align="right" width="150px"/>
## Abstract ## 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. 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.
### Main features ### Main features
...@@ -14,13 +14,14 @@ Scientific communication and data visualization are important aspects to illustr ...@@ -14,13 +14,14 @@ Scientific communication and data visualization are important aspects to illustr
![](man/figures/i2dash_image.jpg) ![](man/figures/i2dash_image.jpg)
*A customized dashboards can be integrated into an existing data analysis pipelines in R (left). After initialization, pages containing components with customized content can be added step-by-step to the dashboard at any stage of the data analysis. The final dashboard is assembled into an R markdown file, and shared together with RDS data files for further use within RStudio, or can also be deployed on a R Shiny Server or as stand-alone HTML file.* *A customized dashboard can be integrated into an existing data analysis pipelines in R (left). After initialization, pages containing components with customized content can be added step-by-step to the dashboard at any stage of the data analysis. The final dashboard is assembled into an R markdown file, and shared together with RDS data files for further use within RStudio, or can also be deployed on a R Shiny Server or as stand-alone HTML file.*
## Installation: ## Installation:
```r The package can be installed with the `r BiocStyle::CRANpkg("remotes")` library:
install.packages("BiocManager")
BiocManager::install("i2dash") ```{r, eval=FALSE}
remotes::install_git(url = "https://gitlab.gwdg.de/loosolab/software/i2dash.git", repos = BiocManager::repositories())
``` ```
## Where to start ## Where to start
...@@ -29,7 +30,7 @@ BiocManager::install("i2dash") ...@@ -29,7 +30,7 @@ BiocManager::install("i2dash")
## Extension ## Extension
It is possible to extend the core functionality of **i2dash** with tempates 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. 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**](https://gitlab.gwdg.de/loosolab/software/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. - [**i2dash.scrnaseq**](https://gitlab.gwdg.de/loosolab/software/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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment