idiogramFISH: Shiny App. Idiograms with Marks and Karyotype Indices
Introduction
The goal of idiogramFISH functions or shiny-app is to plot
karyotypes, plasmids and circular chr. having a set of data.frames for
chromosome data and optionally marks’ data (Roa and PC Telles,
2021). Karyotypes can also be plotted in concentric
circles.
It is possible to calculate also chromosome and
karyotype indexes (Romero-Zarco, 1986; Watanabe et al., 1999) and
classify chromosome morphology in the categories of Levan (1964), and Guerra
(1986).
Six styles of marks are
available: square (squareLeft), dots, cM (cMLeft), cenStyle, upArrow
(downArrow), exProtein (inProtein) (column style
in
dfMarkColor
data.frame); its legend (label) (parameter
legend
) can be drawn inline or to the right 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
, q
, cen
,
pcen
, qcen
. The last three cannot accommodate
most mark styles, but can be colored. The region w
can be
used both in monocentrics and holocentrics.
IdiogramFISH was written in R (R Core Team, 2019) and also uses crayon (Csárdi, 2017), tidyr (Wickham and Henry, 2020), plyr (Wickham, 2011) and dplyr packages (Wickham et al., 2019). Documentation was written with R-packages roxygen2 (Wickham et al., 2018), usethis (Wickham and Bryan, 2019), bookdown (Xie, 2016), knitr (Xie, 2015), pkgdown (Wickham and Hesselberth, 2019), Rmarkdown (Xie et al., 2018), rvcheck (Yu, 2019a), badger (Yu, 2019b), kableExtra (Zhu, 2019), rmdformats (Barnier, 2020) and RCurl (Temple Lang and CRAN team, 2019). For some vignette figures, packages rentrez (Winter, 2017), phytools (Revell, 2012), ggtree (Yu et al., 2018), ggplot2 (Wickham, 2016) and ggpubr (Kassambara, 2019) were used.
In addition, the shiny app runBoard()
uses shiny (Chang
et al., 2021), shinydashboard (Chang and Borges Ribeiro, 2018),
rhandsontable (Owen, 2018), gtools (Warnes
et al., 2020) and rclipboard (Bihorel, 2021).
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 localhost:8080
# Stop the container
docker ps
docker stop {container id}
Installation instructions
- Install R on your system
You can install idiogramFISH from CRAN with:
install.packages("idiogramFISH")
Windows users: To avoid installation of packages in OneDrive
.libPaths("D:R/lib") # for example
.libPaths() # set or read libraries
To do that permanently: Search (magnifier) “environment variables”
and set R_LIBS_USER to D:\R\lib
(example)
Need help?
Vignettes
Online:
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()
1 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.
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()
2 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
3 Minimal Examples
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
4 Plotting chromosomes
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
5 Several OTUs
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
6 Changing Units
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
8 Using groups
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
9 Circular plots
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
10 Plotting alongside phylogeny
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
12 Human karyotype
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:Github | Raw |
13 Functions
14 Datasets
References
R-packages
Shiny App
Documentation
These binaries (installable software) and packages are in development.
They may not be fully stable and should be used with caution. We make no claims about them.