idiogramFISH: Shiny App. Idiograms with Marks and Karyotype Indices

Introduction

The goal of idiogramFISH functions or the shiny-app is to plot karyotypes, plasmids and circular chr. having a set of data.frames for chromosome data and optionally marks’ data [@Roa2021]. Karyotypes can also be plotted in concentric circles.

It is possible to calculate also chromosome and karyotype indexes [@Watanabe1999;@Zarco1986new] and classify chromosome morphology in the categories of Levan [-@Levan1964], and Guerra [-@Guerra1986d].

Six styles of marks are available: square (and squareLeft), dots, cM (cMLeft), cenStyle, upArrow (downArrow), exProtein (inProtein) (in column style in dfMarkColor data.frame); its legend (label) (parameter legend) can be drawn inline or to the right (aside) of karyotypes. Three styles of centromere are available: rounded, triangle and inProtein (cenFormat parameter). Chromosome regions (column chrRegion in dfMarkPos data.frame) for monocentrics are p (short), q (long), cen, pcen, qcen. The last three cannot accommodate most mark styles, but can be colored. The region w (whole) can be used both in monocentrics and holocentrics.

IdiogramFISH was written in R [@R-base] and also uses crayon [@R-crayon], tidyr [@R-tidyr], plyr [@plyr2011] and dplyr packages [@R-dplyr]. Documentation was written with R-packages roxygen2 [@R-roxygen2], usethis [@R-usethis], bookdown [@bookdown2016], knitr [@Xie2015], pkgdown [@R-pkgdown], Rmarkdown [@rmarkdown2018], rvcheck [@R-rvcheck], badger [@R-badger], kableExtra [@R-kableExtra], rmdformats [@R-rmdformats] and RCurl [@R-RCurl]. For some vignette figures, packages rentrez [@rentrez2017], phytools [@phytools2012], ggtree [@ggtree2018], ggplot2 [@ggplot22016] and ggpubr [@R-ggpubr] were used.

In addition, the shiny app runBoard() uses shiny [@R-shiny], shinydashboard [@R-shinydashboard], rhandsontable [@R-rhandsontable], gtools [@R-gtools] and rclipboard [@R-rclipboard].

Run the Shiny app with docker

  • No need to install R
  • Install docker on your system
  • Make sure you can run a docker example image, i.e. ubuntu, in the console (system terminal)
docker pull fercyto/idiogramfish

# Run the image
docker run -d -p 8080:8080 fercyto/idiogramfish

In your internet browser go to http://localhost:8080

# Stop the container
docker ps
docker stop {container id}

Installation instructions

CRAN repo https://doi.org/10.5281/zenodo.3579417

You can install idiogramFISH from CRAN with:

install.packages("idiogramFISH")

Windows users: To avoid installation of R-packages in OneDrive

.libPaths()          # read library location
.libPaths("D:R/lib") # set

To do that permanently: Search (magnifier) “environment variables” and set R_LIBS_USER to D:\R\lib (example)

Other option: something in the line of this link

Releases

NEWS

archive

downloads

Need help?

Manual in Bookdown style

https://ferroao.gitlab.io/manualidiogramfish

Documentation in Pkgdown style

https://ferroao.gitlab.io/idiogramFISH/articles/index.html

Vignettes

Online:

https://ferroao.gitlab.io/idiogramfishhelppages

Launch vignettes from R for the installed version:

library(idiogramFISH)
packageVersion("idiogramFISH")
browseVignettes("idiogramFISH")

Citation

To cite idiogramFISH in publications, please use:

Roa F, Telles M. idiogramFISH: Shiny app. Idiograms with Marks and Karyotype Indices. doi: 10.5281/zenodo.3579417

To write citation to file:

sink("idiogramFISH.bib")
toBibtex(citation("idiogramFISH"))
sink()

Working online

Shiny App in the cloud availability:
shinyapps.io

Each chapter has a jupyter version. A jupyter notebook seems an interactive vignette.

They are hosted in github

They can be accessed with google colab to work online.

Open in ColabOpen in Colab  Github  
3 Minimal examples link Raw
4 Plotting chromosomes link Raw
5 Multiple OTUs link Raw
6 Changing units link Raw
7 GISH link Raw
8 Groups link Raw
9 Circular Plots link Raw
10 Plotting alongside phylogeny link Raw
11 Citrus link Raw
12 Human Karyotype link Raw


Chapters can be accessed locally in your jupyter-lab or jupyter notebook

After installing jupyter, you can install the R kernel with:

install.packages("IRkernel")
IRkernel::installspec()

Shiny App

Attention Windows users, might require the last R version to plot correctly.

library(idiogramFISH)
runBoard()

Shiny App in the cloud availability:
shinyapps.io

Minimal Examples

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Plotting chromosomes

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Several OTUs

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Changing Units

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Using groups

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Circular plots

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Plotting alongside phylogeny

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


Human karyotype

https://ferroao.gitlab.io/idiogramfishhelppages


Jupyter interactive version:

Open in ColabOpen in Colab   Github   Raw


References

R-packages

Shiny App

Documentation