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].
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}
You can install idiogramFISH from CRAN with:
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
Online:
Launch vignettes from R for the installed version:
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:
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()
Attention Windows users, might require the last R version to plot correctly.
library(idiogramFISH)
runBoard()
Shiny App in the cloud availability:
shinyapps.io
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |
https://ferroao.gitlab.io/idiogramfishhelppages
Jupyter interactive version:
|
Github | Raw |