README.md

In JinmiaoChenLab/cytofkit2: cytofkit2: an integrated mass cytometry data analysis pipeline. Cytofkit provides functions for data pre-processing, fast clustering, data visualization through linear or non-linear dimensionality reduction, automatic identification of cell subsets, and inference of the relatedness between cell subsets

cytofkit2: an integrated mass cytometry data analysis pipeline

NOTE: This is the development version of cytofkit2 package

cytofkit2

This package is designed to facilitate the analysis workflow of mass cytometry data with automatic subset identification and mapping of cellular progression. Both command line and a GUI client are provided for executing the workflow easily.

Installation

1. Install R and Rstudio

If you have never used R, please install R and Rstudio following the steps below:

• Download the proper R version for your operation system from R download page.

• Double-click the downloaded R installation file, install with all the defaults.

• Download the proper Rstudio version for your operation system from here.

• Double-click the downloaded Rstudio installation file, install with all the defaults.

Special Notes for Mac Users

For Mac OS X 10.8 or later, you need to install XQuartz to support the GUI:

• Download the disk image (dmg) file for XQuartz.

• Open the dmg file by double-clicking on it, you'll find XQuartz.pkg, double-click on it to run the installer, clicking through all the defaults.

• After the installer runs, you'll have to restart your mac computer.

2. Install python

3. Install cytofkit2 package

The offical and stable version, please refer to

• Bioconductor
• GitHub

Install the stable version from Bioconductor, use:

## try http:// if https:// URLs are not supported
if (!requireNamespace("BiocManager", quietly = TRUE))
    install.packages("BiocManager")

BiocManager::install("cytofkit2")

Install this development version, use:

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

BiocManager::install("reticulate")

#### check if python is installed
vv <- system("pyv=\"$(python -V)\" | echo $pyv| grep \"Python\"")
if(vv){
 print("Python is installed")
}

#### install python package umap-learn
library(reticulate)
py_install("umap-learn")

#### install cytofkit2 from github
if(!require(devtools)){
  install.packages("devtools") # If not already installed
}
devtools::install_github("JinmiaoChenLab/cytofkit2", dependencies=TRUE)

Usage

After successfully installing the cytofkit2 package, run the following codes to open the cytofkit2 shiny_dashboard:

library("cytofkit2")
cytofkit_shiny_dashboard()

Check the following vignettes for more details:

• cytofkit2: Analysis Pipeline
• cytofkit2: Quick Start
• cytofkit2: ShinyAPP Tutorial

JinmiaoChenLab/cytofkit2 documentation built on May 12, 2022, 8:09 a.m.