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

Initialized pkgdown

parent 4da1e1cb
No related branches found
No related tags found
1 merge request!23Initialized pkgdown
Pipeline #131220 passed
Showing
with 6017 additions and 12 deletions
......@@ -5,3 +5,6 @@
^README\.md
^doc$
^Meta$
^_pkgdown\.yml$
^docs$
^pkgdown$
# **i2dash**: - **I**nteractive & **i**terative **dash**boards in R <img src="vignettes/images/i2dash_logo.png" align="right" width="150px"/>
# Interactive & iterative dashboards in R
## Abstract
## Abstract <img src="vignettes/images/i2dash_logo.png" align="right" width="150px" />
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
- Easy integration into existing analysis pipelines in R
- Support for multiple components, such as htmlwidgets, tabular data, text, images etc.
- 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
![](man/figures/i2dash_image.jpg)
![](vignettes/images/i2dash_intro.png)
*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.*
*(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:
## Installation
The package can be installed with the `r BiocStyle::CRANpkg("remotes")` library:
The package can be installed with:
```{r, eval=FALSE}
remotes::install_git(url = "https://gitlab.gwdg.de/loosolab/software/i2dash.git", repos = BiocManager::repositories())
```
install.packages("i2dash")
```
## Where to start
......@@ -36,7 +36,9 @@ It is possible to extend the core functionality of **i2dash** with templates for
## How to cite
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
If you use **i2dash** or **i2dash.scrnaseq** in your work, please cite:
Ustjanzew A., Preussner J., Bentsen M., Kuenne C., and Looso M. i2dash: creation of flexible, interactive and web-based dashboards from data analysis pipelines. *tba* (2020)
## License
......
This diff is collapsed.
This diff is collapsed.
File added
File added
File added
File added
File added
File added
File added
File added
File added
This diff is collapsed.
File added
File added
File added
docs/articles/images/example_page1.png

347 KiB

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