Skip to content
Snippets Groups Projects
Commit 7f575013 authored by arsenij.ustjanzew's avatar arsenij.ustjanzew
Browse files

add README.md and index.md(for pkgdown);

run pkgdown::build_site();
relocated images for the vignette;
add _pkgdown.yml
parent 5f468e4e
No related branches found
No related tags found
1 merge request!8Vignette: i2dash introduction
Pipeline #119658 failed
Showing
with 6045 additions and 1 deletion
...@@ -7,7 +7,7 @@ Authors@R: c( ...@@ -7,7 +7,7 @@ Authors@R: c(
person(given = "Jens", family = "Preussner", email = "jens.preussner@mpi-bn.mpg.de", role = c("aut"), comment = c(ORCID = "0000-0003-1927-3458")), person(given = "Jens", family = "Preussner", email = "jens.preussner@mpi-bn.mpg.de", role = c("aut"), comment = c(ORCID = "0000-0003-1927-3458")),
person(given = "Mario", family = "Looso", email = "mario.looso@mpi-bn.mpg.de", role = c("aut"), comment = c(ORCID = "0000-0003-1495-9530"))) person(given = "Mario", family = "Looso", email = "mario.looso@mpi-bn.mpg.de", role = c("aut"), comment = c(ORCID = "0000-0003-1495-9530")))
Description: Easily build dashboards from individual components in HTML and Shiny. Description: Easily build dashboards from individual components in HTML and Shiny.
License: MIT License: MIT + file LICENSE
Encoding: UTF-8 Encoding: UTF-8
LazyData: true LazyData: true
RoxygenNote: 7.0.0 RoxygenNote: 7.0.0
......
# **i2dash**: - **I**nteractive & **i**terative **dash**boards in R <img src="man/figures/i2dash_logo.png" align="right" width="150px"/>
</br>
<hr>
## 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.
### Main features
- Easy integration into existing analysis pipelines in R
- Support for multiple components, such as htmlwidgets, tabular data, 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)
*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.*
## Installation:
```r
install.packages("BiocManager")
BiocManager::install("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.
## 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.
- [**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.
## 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.
## License
This project is licensed under the MIT license.
This diff is collapsed.
This diff is collapsed.
File added
This diff is collapsed.
File added
File added
File added
File added
This diff is collapsed.
File added
File added
File added
File added
This diff is collapsed.
File added
File added
File added
File moved
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