1 Introduction

In this vignette we offer support for users that wish to use our package outside of RStudio and optionally in remote servers.

1.1 How to install ISAnalytics

To install the package run the following code:

## For release version
if(!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
BiocManager::install("ISAnalytics")

## For devel version
if(!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")
# The following initializes usage of Bioc devel
BiocManager::install(version='devel')
BiocManager::install("ISAnalytics")

To install from GitHub:

# For release version
if (!require(devtools)) {
  install.packages("devtools")
}
devtools::install_github("calabrialab/ISAnalytics",
                         ref = "RELEASE_3_12",
                         dependencies = TRUE,
                         build_vignettes = TRUE)

## Safer option for vignette building issue
devtools::install_github("calabrialab/ISAnalytics",
                         ref = "RELEASE_3_12")

# For devel version
if (!require(devtools)) {
  install.packages("devtools")
}
devtools::install_github("calabrialab/ISAnalytics",
                         ref = "master",
                         dependencies = TRUE,
                         build_vignettes = TRUE)

## Safer option for vignette building issue
devtools::install_github("calabrialab/ISAnalytics",
                         ref = "master")
library(ISAnalytics)

1.2 Setting options

ISAnalytics has a verbose option that allows some functions to print additional information to the console while they’re executing. To disable this feature do:

# DISABLE
options("ISAnalytics.verbose" = FALSE)

# ENABLE
options("ISAnalytics.verbose" = TRUE)

Some functions also produce report in a user-friendly HTML format, to set this feature:

# DISABLE HTML REPORTS
options("ISAnalytics.widgets" = FALSE)

# ENABLE HTML REPORTS
options("ISAnalytics.widgets" = TRUE)

2 Recommendations

We highly encourage the use of widgets because some of the functions included in this package produce extensive and detailed reports that are made easy to explore via HTML format: we are talking, usually, about potentially very large data frames which are highly impractical to print on console.

Since we are aware that not all users can or want to use RStudio, here we present a few proposed solutions to maintain widget functionality.

2.1 Running the package on a client machine

If code is run on the user machine but from R gui or console, user should not encounter problems, since widgets will be visualized in your preferred browser. If that’s not the case try:

options(browser = "firefox")

of course “firefox” can be replaced with whatever is needed.

2.2 Running code on a remote machine via VPN

Users can visualize widgets even if they’re running code on a remote machine via VPN with the use of X11.

Provided the server machine has a browser installed (for example firefox), you can enable X11 via ssh by doing:

ssh YOUR_USERNAME@server_address -X -Y

On the client side, users must have an X11 client such as XQuartz to allow X11 forwarding.

If users are working from a Windows machine the procedure is a bit more complicated, since the operating system is not Unix-like.

  1. Download Xming here: http://www.straightrunning.com/XmingNotes/ and puTTY here: https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html
  2. Once installed, run Xming and puTTY
  3. In puTTY configurations, on the left side, find “SSH” -> “X11”
  4. Check the option “Enable X11 forwarding”
  5. Back in the “Session” panel enter the IP address and as connection type select “SSH”
  6. Finally open a connection and try opening the browser from console

Once connected, open R and set the browser option, then load ISAnalytics:

options(browser = "firefox")
library(ISAnalytics)

3 Reproducibility

The ISAnalytics package (calabrialab, 2021) was made possible thanks to:

This package was developed using biocthis.

R session information.

#> ─ Session info ───────────────────────────────────────────────────────────────────────────────────────────────────────
#>  setting  value                       
#>  version  R version 4.0.3 (2020-10-10)
#>  os       Ubuntu 18.04.5 LTS          
#>  system   x86_64, linux-gnu           
#>  ui       X11                         
#>  language (EN)                        
#>  collate  C                           
#>  ctype    en_US.UTF-8                 
#>  tz       America/New_York            
#>  date     2021-02-17                  
#> 
#> ─ Packages ───────────────────────────────────────────────────────────────────────────────────────────────────────────
#>  package       * version date       lib source        
#>  assertthat      0.2.1   2019-03-21 [2] CRAN (R 4.0.3)
#>  BiocManager     1.30.10 2019-11-16 [2] CRAN (R 4.0.3)
#>  BiocParallel    1.24.1  2021-02-17 [2] Bioconductor  
#>  BiocStyle     * 2.18.1  2021-02-17 [2] Bioconductor  
#>  bookdown        0.21    2020-10-13 [2] CRAN (R 4.0.3)
#>  cli             2.3.0   2021-01-31 [2] CRAN (R 4.0.3)
#>  colorspace      2.0-0   2020-11-11 [2] CRAN (R 4.0.3)
#>  crayon          1.4.1   2021-02-08 [2] CRAN (R 4.0.3)
#>  DBI             1.1.1   2021-01-15 [2] CRAN (R 4.0.3)
#>  digest          0.6.27  2020-10-24 [2] CRAN (R 4.0.3)
#>  dplyr           1.0.4   2021-02-02 [2] CRAN (R 4.0.3)
#>  ellipsis        0.3.1   2020-05-15 [2] CRAN (R 4.0.3)
#>  evaluate        0.14    2019-05-28 [2] CRAN (R 4.0.3)
#>  fansi           0.4.2   2021-01-15 [2] CRAN (R 4.0.3)
#>  forcats         0.5.1   2021-01-27 [2] CRAN (R 4.0.3)
#>  fs              1.5.0   2020-07-31 [2] CRAN (R 4.0.3)
#>  generics        0.1.0   2020-10-31 [2] CRAN (R 4.0.3)
#>  ggplot2         3.3.3   2020-12-30 [2] CRAN (R 4.0.3)
#>  ggrepel         0.9.1   2021-01-15 [2] CRAN (R 4.0.3)
#>  glue            1.4.2   2020-08-27 [2] CRAN (R 4.0.3)
#>  gtable          0.3.0   2019-03-25 [2] CRAN (R 4.0.3)
#>  highr           0.8     2019-03-20 [2] CRAN (R 4.0.3)
#>  hms             1.0.0   2021-01-13 [2] CRAN (R 4.0.3)
#>  htmltools       0.5.1.1 2021-01-22 [2] CRAN (R 4.0.3)
#>  htmlwidgets     1.5.3   2020-12-10 [2] CRAN (R 4.0.3)
#>  httr            1.4.2   2020-07-20 [2] CRAN (R 4.0.3)
#>  ISAnalytics   * 1.0.10  2021-02-17 [1] Bioconductor  
#>  jsonlite        1.7.2   2020-12-09 [2] CRAN (R 4.0.3)
#>  knitcitations * 1.0.12  2021-01-10 [2] CRAN (R 4.0.3)
#>  knitr           1.31    2021-01-27 [2] CRAN (R 4.0.3)
#>  lattice         0.20-41 2020-04-02 [2] CRAN (R 4.0.3)
#>  lifecycle       1.0.0   2021-02-15 [2] CRAN (R 4.0.3)
#>  lubridate       1.7.9.2 2020-11-13 [2] CRAN (R 4.0.3)
#>  magrittr      * 2.0.1   2020-11-17 [2] CRAN (R 4.0.3)
#>  mnormt          2.0.2   2020-09-01 [2] CRAN (R 4.0.3)
#>  munsell         0.5.0   2018-06-12 [2] CRAN (R 4.0.3)
#>  nlme            3.1-152 2021-02-04 [2] CRAN (R 4.0.3)
#>  pillar          1.4.7   2020-11-20 [2] CRAN (R 4.0.3)
#>  pkgconfig       2.0.3   2019-09-22 [2] CRAN (R 4.0.3)
#>  plyr            1.8.6   2020-03-03 [2] CRAN (R 4.0.3)
#>  psych           2.0.12  2020-12-16 [2] CRAN (R 4.0.3)
#>  purrr           0.3.4   2020-04-17 [2] CRAN (R 4.0.3)
#>  R6              2.5.0   2020-10-28 [2] CRAN (R 4.0.3)
#>  Rcpp            1.0.6   2021-01-15 [2] CRAN (R 4.0.3)
#>  reactable       0.2.3   2020-10-04 [2] CRAN (R 4.0.3)
#>  readr           1.4.0   2020-10-05 [2] CRAN (R 4.0.3)
#>  RefManageR      1.3.0   2020-11-13 [2] CRAN (R 4.0.3)
#>  rlang           0.4.10  2020-12-30 [2] CRAN (R 4.0.3)
#>  rmarkdown       2.6     2020-12-14 [2] CRAN (R 4.0.3)
#>  scales          1.1.1   2020-05-11 [2] CRAN (R 4.0.3)
#>  sessioninfo   * 1.1.1   2018-11-05 [2] CRAN (R 4.0.3)
#>  stringi         1.5.3   2020-09-09 [2] CRAN (R 4.0.3)
#>  stringr         1.4.0   2019-02-10 [2] CRAN (R 4.0.3)
#>  tibble          3.0.6   2021-01-29 [2] CRAN (R 4.0.3)
#>  tidyr           1.1.2   2020-08-27 [2] CRAN (R 4.0.3)
#>  tidyselect      1.1.0   2020-05-11 [2] CRAN (R 4.0.3)
#>  tmvnsim         1.0-2   2016-12-15 [2] CRAN (R 4.0.3)
#>  upsetjs         1.9.0   2021-02-15 [2] CRAN (R 4.0.3)
#>  utf8            1.1.4   2018-05-24 [2] CRAN (R 4.0.3)
#>  vctrs           0.3.6   2020-12-17 [2] CRAN (R 4.0.3)
#>  withr           2.4.1   2021-01-26 [2] CRAN (R 4.0.3)
#>  xfun            0.21    2021-02-10 [2] CRAN (R 4.0.3)
#>  xml2            1.3.2   2020-04-23 [2] CRAN (R 4.0.3)
#>  yaml            2.2.1   2020-02-01 [2] CRAN (R 4.0.3)
#>  zip             2.1.1   2020-08-27 [2] CRAN (R 4.0.3)
#> 
#> [1] /tmp/Rtmpw7lbMU/Rinst83e69acd882
#> [2] /home/biocbuild/bbs-3.12-bioc/R/library

4 Bibliography

This vignette was generated using BiocStyle (Oleś, Morgan, and Huber, 2021) with knitr (Xie, 2021) and rmarkdown (Allaire, Xie, McPherson, Luraschi, et al., 2020) running behind the scenes.

Citations made with knitcitations (Boettiger, 2021).

[1] J. Allaire, Y. Xie, J. McPherson, J. Luraschi, et al. rmarkdown: Dynamic Documents for R. R package version 2.6. 2020. <URL: https://github.com/rstudio/rmarkdown>.

[2] C. Boettiger. knitcitations: Citations for ‘Knitr’ Markdown Files. R package version 1.0.12. 2021. <URL: https://CRAN.R-project.org/package=knitcitations>.

[3] G. Csárdi, R. core, H. Wickham, W. Chang, et al. sessioninfo: R Session Information. R package version 1.1.1. 2018. <URL: https://CRAN.R-project.org/package=sessioninfo>.

[4] A. Oleś, M. Morgan, and W. Huber. BiocStyle: Standard styles for vignettes and other Bioconductor documents. R package version 2.18.1. 2021. <URL: https://github.com/Bioconductor/BiocStyle>.

[5] R Core Team. R: A Language and Environment for Statistical Computing. R Foundation for Statistical Computing. Vienna, Austria, 2020. <URL: https://www.R-project.org/>.

[6] H. Wickham. “testthat: Get Started with Testing”. In: The R Journal 3 (2011), pp. 5-10. <URL: https://journal.r-project.org/archive/2011-1/RJournal_2011-1_Wickham.pdf>.

[7] Y. Xie. knitr: A General-Purpose Package for Dynamic Report Generation in R. R package version 1.31. 2021. <URL: https://yihui.org/knitr/>.

[8] calabrialab. Analyze gene therapy vector insertion sites data identified from genomics next generation sequencing reads for clonal tracking studies. https://github.com/calabrialab/ISAnalytics - R package version 1.0.10. 2021. DOI: 10.18129/B9.bioc.ISAnalytics. <URL: http://www.bioconductor.org/packages/ISAnalytics>.