Installing and Loading the Package

To install oneSENSE package, start R and run the following code:

if (!requireNamespace("BiocManager", quietly=TRUE))
    install.packages("BiocManager")
BiocManager::install("oneSENSE")

Load the package with the following code

library(oneSENSE)

Read the package description to find out more about oneSENSE GUI

? "onesense_GUI()"

## No documentation for 'onesense_GUI()' in specified packages and libraries:
## you could try '??onesense_GUI()'

Using the oneSENSE package

Rational of One-SENSE

One-SENSE measures cellular parameters assinged to manually predefined
catergories, and a one-dimensional map is constructed for each catergory
using t-SNE. Each dimension is informative and can be annotated through
the use of heatplots aligned in parallel to each axis, allowing for
simultaneous visualization of two catergories across a two-dimensional plot.
The cellular occupancy of the resulting plots alllows for direct assessment
of the relationships between the categories.

Run oneSENSE using the GUI

The easiest way to access oneSENSE is via the Graphics User Interface(GUI)
provided in the package. After loading the package, simply set the directory
as instructed in the note above and run the following code:

onesense_GUI()

The interface will appear like below, you can click the information button
! to check the explanation for each entry and customize your own analysis.

1. Choose the directory where the FCS files are located.

Selecting FCS directory

2. Display the markers you want to select

Display Markers

3. Select the first, second and/or third(optional) category of markers
you want to group together Select Markers by Catergory

4. Input the number you want to subsample from each FCS file under ceil.

Ceiling and Bins

5. Input the number of bins you want for the cells to be sorted into

6. Press submit and it will run to produce median heatplots

7. If you wish to do a frequency heatmap, press select coordinates,
and after selecting coordinates, press generate CSV.

Coordinate Selection

8. Press submit frequency heatplot to generate a different set of heatplot Frequency Heatplot Submission

Depending on the size of your data, it will take some time to run
the analysis. Once done, the oneSENSE visualisations will be displayed.

Median Heatplot example

Median Heatplot

Frequency Heatplot example

Frequency Heatplot

Session Information

sessionInfo()

## R version 4.2.0 RC (2022-04-19 r82224)
## Platform: x86_64-pc-linux-gnu (64-bit)
## Running under: Ubuntu 20.04.4 LTS
## 
## Matrix products: default
## BLAS:   /home/biocbuild/bbs-3.15-bioc/R/lib/libRblas.so
## LAPACK: /home/biocbuild/bbs-3.15-bioc/R/lib/libRlapack.so
## 
## locale:
##  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
##  [3] LC_TIME=en_GB              LC_COLLATE=C              
##  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=en_US.UTF-8   
##  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C                 
##  [9] LC_ADDRESS=C               LC_TELEPHONE=C            
## [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       
## 
## attached base packages:
## [1] stats     graphics  grDevices utils     datasets  methods   base     
## 
## other attached packages:
## [1] oneSENSE_1.18.0      scatterplot3d_0.3-41 shinyFiles_0.9.1    
## [4] shiny_1.7.1          webshot_0.5.3       
## 
## loaded via a namespace (and not attached):
##  [1] Biobase_2.56.0      httr_1.4.2          sass_0.4.1         
##  [4] tidyr_1.2.0         jsonlite_1.8.0      viridisLite_0.4.0  
##  [7] gtools_3.9.2        bslib_0.3.1         RcppParallel_5.1.5 
## [10] assertthat_0.2.1    stats4_4.2.0        yaml_2.3.5         
## [13] pillar_1.7.0        glue_1.6.2          digest_0.6.29      
## [16] promises_1.2.0.1    colorspace_2.0-3    htmltools_0.5.2    
## [19] httpuv_1.6.5        pkgconfig_2.0.3     purrr_0.3.4        
## [22] flowCore_2.8.0      xtable_1.8-4        scales_1.2.0       
## [25] later_1.3.0         Rtsne_0.16          tibble_3.1.6       
## [28] generics_0.1.2      ggplot2_3.3.5       ellipsis_0.3.2     
## [31] BiocGenerics_0.42.0 lazyeval_0.2.2      cli_3.3.0          
## [34] magrittr_2.0.3      crayon_1.5.1        mime_0.12          
## [37] evaluate_0.15       fs_1.5.2            fansi_1.0.3        
## [40] gplots_3.1.3        tools_4.2.0         data.table_1.14.2  
## [43] lifecycle_1.0.1     matrixStats_0.62.0  stringr_1.4.0      
## [46] plotly_4.10.0       S4Vectors_0.34.0    munsell_0.5.0      
## [49] compiler_4.2.0      jquerylib_0.1.4     caTools_1.18.2     
## [52] rlang_1.0.2         grid_4.2.0          htmlwidgets_1.5.4  
## [55] bitops_1.0-7        rmarkdown_2.14      cytolib_2.8.0      
## [58] gtable_0.3.0        DBI_1.1.2           R6_2.5.1           
## [61] RProtoBufLib_2.8.0  knitr_1.38          dplyr_1.0.8        
## [64] fastmap_1.1.0       utf8_1.2.2          KernSmooth_2.23-20 
## [67] stringi_1.7.6       Rcpp_1.0.8.3        vctrs_0.4.1        
## [70] tidyselect_1.1.2    xfun_0.30

Quickstart guide

Tan Yong kee

2022-04-26