<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Iterative and Interactive Dashboards • i2dash</title>
<!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
<link rel="apple-touch-icon" type="image/png" sizes="180x180" href="apple-touch-icon.png">
<link rel="apple-touch-icon" type="image/png" sizes="120x120" href="apple-touch-icon-120x120.png">
<link rel="apple-touch-icon" type="image/png" sizes="76x76" href="apple-touch-icon-76x76.png">
<link rel="apple-touch-icon" type="image/png" sizes="60x60" href="apple-touch-icon-60x60.png">
<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous">
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="bootstrap-toc.css">
<script src="bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous">
<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
<script src="pkgdown.js"></script><meta property="og:title" content="Iterative and Interactive Dashboards">
<meta property="og:description" content="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.">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body data-spy="scroll" data-target="#toc">
<div class="container template-home">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">i2dash</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.2</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="index.html">
<span class="fas fa fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="reference/index.html">Reference</a>
</li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
Articles
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="articles/i2dash-intro.html">Creating iterative and interactive dashboards with i2dash</a>
</li>
</ul>
</li>
</ul>
<ul class="nav navbar-nav navbar-right"></ul>
</div>
<!--/.nav-collapse -->
</div>
<!--/.container -->
</div>
<!--/.navbar -->
</header><div class="row">
<div class="contents col-md-9">
<div id="interactive--iterative-dashboards-in-r" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
<a href="#interactive--iterative-dashboards-in-r" class="anchor"></a>Interactive & iterative dashboards in R</h1></div>
<div id="abstract-" class="section level2">
<h2 class="hasAnchor">
<a href="#abstract-" class="anchor"></a>Abstract <img src="articles/images/i2dash_logo.png" align="right" width="150px">
</h2>
<p>Scientific communication and data visualization are important aspects to illustrate complex concepts and results from data analyses. The R package <strong>i2dash</strong> provides functionality to create customized, web-based dashboards for data presentation, exploration and sharing. <strong>i2dash</strong> integrates easily into existing data analysis pipelines and can organize scientific findings thematically across different pages and layouts.</p>
<div id="main-features" class="section level3">
<h3 class="hasAnchor">
<a href="#main-features" class="anchor"></a>Main features</h3>
<ul>
<li>Easy integration into existing analysis pipelines in R for programmatic dashboard creation</li>
<li>Provides a selection of predefined layouts to arrange content</li>
<li>Support for multiple components, such as htmlwidgets, tables, text, images etc.</li>
<li>Creation of web-based, sharable, static or interactive dashboards</li>
<li>Enables a flexible and iterative cycle of dashboard development</li>
</ul>
</div>
</div>
<div id="installation" class="section level2">
<h2 class="hasAnchor">
<a href="#installation" class="anchor"></a>Installation</h2>
<p>The package can be installed with:</p>
<pre><code><a href="https://rdrr.io/r/utils/install.packages.html">install.packages("i2dash")</a></code></pre>
</div>
<div id="extension" class="section level2">
<h2 class="hasAnchor">
<a href="#extension" class="anchor"></a>Extension</h2>
<p>It is possible to extend the core functionality of <strong>i2dash</strong> 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.</p>
<ul>
<li>
<a href="https://gitlab.gwdg.de/loosolab/software/i2dash.scrnaseq"><strong>i2dash.scrnaseq</strong></a> 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.</li>
</ul>
</div>
<div id="run-i2dash-using-docker" class="section level2">
<h2 class="hasAnchor">
<a href="#run-i2dash-using-docker" class="anchor"></a>Run i2dash using Docker</h2>
<p>At first, install <a href="https://docs.docker.com/engine/install/">Docker</a>. Then pull the image of <strong>i2dash</strong>:</p>
<p><code>docker pull docker.gitlab.gwdg.de/loosolab/container/i2dash.deployment:r3.6.3_bioc3.10</code></p>
<p>The next step is to run a container and simultaneously load the dashboard files (the <code>.Rmd</code> file and all files of the <code><a href="reference/i2dashboard-methods.html">datadir(dashboard)</a></code> directory) into the container. To mount custom data into the container, make use of Docker’s <code>-v</code> parameter to mount a host directory into the container. Inside the container, <strong>i2dash</strong> looks for external datasets in <code>/srv/shiny-server/</code>. Use the following code, where you exchange <code>/path/to/dashboard/files</code> with the respective path to the directory containing the <code>.Rmd</code> file and all files of the <code><a href="reference/i2dashboard-methods.html">datadir(dashboard)</a></code> directory.</p>
<p><code>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</code></p>
<p>Now, view the dashboard with your browser at <code>3838:3838</code>.</p>
</div>
<div id="faq" class="section level2">
<h2 class="hasAnchor">
<a href="#faq" class="anchor"></a>FAQ</h2>
<ul>
<li>
<strong>The Rmd file of the dashboard contains pages and components but after rendering the dashboard remains empty:</strong> Make sure you have a current version of pandoc installed and view the dashboard only with a modern browser.</li>
</ul>
</div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<div class="links">
<h2>Links</h2>
<ul class="list-unstyled">
<li>Download from CRAN at <br><a href="https://cloud.r-project.org/package=i2dash">https://cloud.r-project.org/package=i2dash</a>
</li>
<li>Visit our webpage at <br><a href="https://loosolab.mpi-bn.mpg.de">https://loosolab.mpi-bn.mpg.de</a>
</li>
</ul>
</div>
<div class="license">
<h2>License</h2>
<ul class="list-unstyled">
<li><a href="LICENSE.html">Full license</a></li>
<li><small><a href="https://opensource.org/licenses/mit-license.php">MIT</a> + file <a href="LICENSE-text.html">LICENSE</a></small></li>
</ul>
</div>
<div class="citation">
<h2>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html">Citing i2dash</a></li>
</ul>
</div>
<div class="developers">
<h2>Developers</h2>
<ul class="list-unstyled">
<li>Arsenij Ustjanzew <br><small class="roles"> Author, maintainer, copyright holder </small> </li>
<li>Jens Preussner <br><small class="roles"> Author, copyright holder </small> <a href="https://orcid.org/0000-0003-1927-3458" target="orcid.widget" aria-label="ORCID"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
<li>Mario Looso <br><small class="roles"> Author, copyright holder </small> <a href="https://orcid.org/0000-0003-1495-9530" target="orcid.widget" aria-label="ORCID"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
</ul>
</div>
</div>
</div>
<footer><div class="copyright">
<p>Developed by Arsenij Ustjanzew, Jens Preussner, Mario Looso.</p>
</div>
<div class="pkgdown">
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
</div>
</footer>
</div>
</body>
</html>