Skip to content

CPTPGenomicTranscriptomic/FlowAIAll

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
www
 
 
 
 
 
 
 
 

FlowAIAll

Clean cytometry data using FlowAI R package through a new Rshiny interface.


Launch FlowAIAll directly from R and GitHub (preferred approach)

User can choose to run FlowAIAll installed locally for a more preferable experience.

Step 1: Install R and RStudio

Before running the app you will need to have R and RStudio installed (tested with R 3.5.3 and RStudio 1.1.463).
Please check CRAN (https://cran.r-project.org/) for the installation of R.
Please check https://www.rstudio.com/ for the installation of RStudio.

Step 2: Install the R Shiny package and other packages required by FlowAIAll

Start an R session using RStudio and run this line:

if (!require("shiny")){install.packages("shiny")}  

Rstudio (in the console) can ask about updates.

If a message like: "Update all/some/none?" appears in the Rstudio console just press "n" and enter.

Step 3: Start the app

Start an R session using RStudio and run this line:

shiny::runGitHub("FlowAIAll", "CPTPGenomicTranscriptomic")

Rstudio (in the console) can ask about updates.

If a message like: "Update all/some/none?" appears in the Rstudio console just press "n" and enter (can happen several times).

This command will download the code of FlowAIAll from GitHub to a temporary directory of your computer and then launch the FlowAIAll app in the web browser. Once the web browser was closed, the downloaded code of FlowAIAll would be deleted from your computer. Next time when you run this command in RStudio, it will download the source code of FlowAIAll from GitHub to a temporary directory again.

Step 4: Choose your analysis set up

1. Choose your output directory:

Choose the operating system (Windows pr MAC) in the top rigth corner.

The from root select the output directory.

The application can crash (everything in grey, no interactivity) if you choose the wrong operating system, if you choose a directory where you haven't some rigths and others...

Experts can try others Volumes (as currentDirectory, home, etc...) but they have to use the application on local.

2. Choose your output options:

  • Write file with high quality events only ("_hQC.fcs") will write a fcs file without any low quality events predicted by flowAI => biological events.

  • Write file with low quality events only ("_lQC.fcs") will write a fcs file without any high quality events predicted by flowAI => artefactual/technical/... events.

  • Write file with both low (remove_from_all/QC < 10,000) and high (remove_from_all/QC > 10,000) quality events ("_QC.fcs"). This file contains a new parameter (visible on flowJo) which allows the distinction between the low and the high quality events.

3. Upload your FCS files:

You can upload from one to multiple *.fcs files.

The files must have the .fcs extension to appear in the selection browser.

One of the parameter should be time/Time/TIME else the application will run forever.

Be aware that The application is limited to 500Mo of RAM.

Multiple runs can be preferable in case of big data analyses.

The blue progress bar should move until the message "upload complete" appears.

4. Wait for the computation:

Once the upload competed a progress boxe should appears in the rigth-bottom corner. It indicates that the application is running and which input file is processed.

5. The results:

Once the progress box has disappeared.

The inputs files should be listed below "Remember your input files were:".

The ouput directory should appears below "Remember your output directory was".

This message "You can look at "resultsQC" directory to see the results!" should be print below "If the next line is in red ... it's your problem... not mine, YOUR'S... Good luck!".

If any Red word or line appears the apllication has encountered an error. Don't hesitate to look at the Rstudio console to track the problem.

The results should be located at the output directory.

The webpage should look like this!

alt text

Comments

The package flowAI seems to filtered much more data than flowClean but it's faster.

About

Clean cytometry data using FlowAI R package through a new Rshiny interface

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages