Skip to content

Latest commit

 

History

54 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VisualizeTRACS

Introduction

VisualizeTRACS is an R-based tool that allows you to visualize data from TRACS (Toolset for the Ranked Analysis of CRISPR Screens). Unlike TRACS, VisualizeTRACS does not need a powerful computer. You can download the TRACS output file from a remote server (if you used one to run TRACS) and use VisualizeTRACS on a local computer to explore the data.

VisualizeTRACS can also be installed on a server for shared access within your group.

The latest release can be downloaded here

A sample TRACS output file can be downloaded here to test VisualizeTRACS

Table of Contents

Installation & Requirements

The minimum requirements for running VisualizeTRACS are:

To install the minimum required packages, enter these commands in R:

install.packages("shiny")
install.packages("shinydashboard")

Then follow the steps below to Run VisualizeTRACS.

All other required components should be installed upon first launch. If you run into an error, you can manually install these other components:

install.packages("shiny")
install.packages("shinydashboard")
install.packages("scatterD3")
install.packages("plotly")
install.packages("DT")
install.packages("shinyjqui")
install.packages("colourpicker")

Run VisualizeTRACS

There are two ways to run VisualizeTRACS

  1. Automatically download and run the latest version directly from GitHub:

    1. Open a new R session and enter these commands:
    library(shiny)
    library(shinydashboard)
    runGitHub("VisualizeTRACS", "developerpiru")
    
  2. Download a local copy and launch your local copy

    1. Download the latest release from here or by using the download button above
    2. Extract the zip archive
    3. Open a new R session and enter these commands:
    library(shiny)
    library(shinydashboard)
    runApp("/path/to/folder/VisualizeTRACS-version")
    

    Where /path/to/folder/ is the directory where you extracted the zip archive and version is the version number you downloaded, e.g. 3.0.0.

If you are using R, a browser window should open automatically showing the app. If you are using RStudio, click "Open in browser" at the top of the popup window.

Usage

VisualizeTRACS requires you to load a TRACS output file (in csv format).

Image of experiment folder

Click Browse in the main tab to select the file.

Image of load data interface

You can then view a 3D plot of all scores (Library ES on the z axis, Final ES on the x axis, and Initial ES on the y axis). You can customize the colors for the filtered and unfiltered genes. By default, the first quartile (bottom 25%) of Library ES is set as the minimum threshold for Library ES (genes below this cutoff will be dropped).

Image of 3D plot

Next you can view a plot of the Initial ES vs. Final ES based on the genes you have filtered for using the sidebar in the 3D Plot tab. The diagonal line runs along y=x; any genes below this line have a negative Enrichment Ratio (ER) and any genes above it have a positive ER.

Image of 2D plot

You can view a table of the genes you have filtered in the Data Table tab. You can sort the data by any column. Click on the gene names to the Gene Cards listing for that gene. Use the download buttons to download the filtered table. You can also click on rows to select individual genes and use the "Download Selected Genes" button to only download a table of those genes.

Image of Data table

About

R-based visualizer tool for TRACS data

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages