---
title: "Creating an extension package for i2dash"
author:
- name: Jens Preussner
  affiliation: 
  email: jens.preussner@mpi-bn.mpg.de
- name: Arsenij Ustjanzew
  affiliation: 
  email: arsenij.ustjanzew@@gmail.com
date: "`r BiocStyle::doc_date()`"
package: "`r BiocStyle::pkg_ver('i2dash')`"
output: 
  rmarkdown::html_document:
    toc: true
    toc_float: true
    fig_caption: true
vignette: >
  %\VignetteIndexEntry{Creating an extension package for i2dash}
  %\VignettePackage{i2dash}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

Vignette last complied on `r Sys.Date()`. i2dash is licenced under `r utils::packageDescription("i2dash")[["License"]]`.

```{r style, echo = FALSE, results = 'asis', include = FALSE}
BiocStyle::markdown()
```

```{r setup, include = FALSE}
knitr::opts_chunk$set(
    collapse = TRUE,
    comment = "#>",
    error = FALSE,
    warning = FALSE,
    message = FALSE
)
stopifnot(requireNamespace("htmltools"))
htmltools::tagList(rmarkdown::html_dependency_font_awesome())

library(magrittr)
```

<img src="images/i2dash_logo.png" align="center" width="150px"/>

# Introduction and scope


## Directory structure

```{r fig-1, fig.cap = "Figure 1: Directory structure for an extension R package.", eval = TRUE, echo = FALSE}
knitr::include_graphics("/vignettes/images/file_sructure.png")
```


## Concept of extendibility

```{r fig-2, fig.cap = "Figure 2: Concept of extending i2dash.", eval = TRUE, echo = FALSE}
knitr::include_graphics("/vignettes/images/concept1.png", error = FALSE)
```

```{r fig-3, fig.cap = "Figure 2: Our example project in this concept.", eval = TRUE, echo = FALSE}
knitr::include_graphics("/vignettes/images/concept2.png", error = FALSE)
```

# Main function

# Template of the component

## Two visualization modes

# Testing the package extension

# Session Info {.unnumbered}

```{r sessioninfo}
sessionInfo()
```
