Skip to content

Latest commit

 

History

History
144 lines (108 loc) · 11.8 KB

README.md

File metadata and controls

144 lines (108 loc) · 11.8 KB
Raw

PATH-SURVEYOR-Suite

Recent Updates:

  • The file input methods for the PATH SURVEYOR Shiny app now been updated. The app can accept file input in the backend before app startup, or if no file is provided, the user can input files via the user interface or the user may append onto the browser URL of the application and designate input file urls. The URL will be parsed and the file names and parameters will be extracted. Below are the query names and their definition.

  • expr= URL path to expression file

  • meta= URL path to meta/clinical file

  • param= (OPTIONAL) URL path to meta/clinical paramater file described below

  • proj= (OPTIONAL) Desired project name

Introduction

The integration of patient genome expression data, phenotype data, and clinical data can serve as an integral resource for patient prognosis and treatment guidance. The PATH SURVEYOR Suite: PATHway level SURVival EnquirY for Immuno-Oncology and Drug Repurposing serves to do just that, by examining the interaction of gene or gene set pathway expression with clinical data to discover prominent features that play a role in patient outcome. This utility is comprised of R Shiny apps and a pipeline script which can be employed in a cohesive manor to provide an in-depth analysis towards underlying features affective survival. Through a systematic Cox proportional regression pipeline the expression of individual genes or gene set pathways is linked with a hazard ratio and p.values to determine signifigance and patient risk, which can be followed by interactive visualization in the suite of R Shiny applications.

Users can download and employ all of the tools locally to perform analyses and gain an in-depth perspective of their own data. To start, we provide example skin cancer data from the PAN ICI (Immune Checkpoint Inhibition) iAtlas database. Additionally, we provied a comprehensive set of pathways which havew been derieved from a variety of databases, such as MSigDB, LINCS L1000, Cell Marker, as well as derived gene sets focusing on ER stress and immune signatures. The example data and provided gene sets will be referenced and utilized throughout the guided overview of the PATH-SURVEYOR Suite of tools.

The PATH-SURVEYOR Family

Github Link Example
PATH-SURVEYOR File Prep App Link to Example App
PATH-SURVEYOR App [Interactive Mode] Link to Example App
PATH-SURVEYOR Cox Proportional Hazards Ranking [Pipeline Mode]
Pathway Connectivity App Link to Example App
Pre-Ranked Hazard Ratio GSEA App Link to Example App
PATH-SURVEYOR App with User File Input Link to Example App
PATH-SURVEYOR Docker Suite

alt text

Installation

Required Files

alt text

  • Expression Matrix

    • Tab delimited matrix with HGNC gene symbols in the first column and sample names as the first-row header
    • Depending on the size, users may want to remove lowly expressed genes to reduce load time

  • Clinical Meta Information

    • Tab-delimited file which should contain a first column of sample names matching the names in the expression matrix, followed by event and time-to-event information, as well as additional covariates or pre-processed scores

  • Clinical Feature Parameter

    • Tab-delimited two-column file where the first column consists of column names of the “Clinical Meta Information File” and the second column defining the column type
      • SampleName (mandatory): Contains sample names matching the expression data
      • SurvivalTime (mandatory): Contains the overall survival time in days for the samples (can be other types of survival)
      • SurvivalID (mandatory): Contains the survival ID for the samples, should be in a 0/1 format, 0 for alive/no event or 1 for dead/event (can be other types of survival)
      • SampleType (optional): Higher level grouping of patient samples
      • Feature (mandatory): One of more clinical or non-clinical features that can be included in the Cox-hazard analysis model.

  • NEW FEATURE added to clean, properly format, and generate a Clinical Feature Parameter File for you here: https://github.com/shawlab-moffitt/PATH-SURVEYOR-Suite/tree/main/1-Getting_Started/2-FilePrep

Immune Deconvolution Pre-Processing (Optional)

  • Script
  • Input
    • ProjectName: A descriptive name for your project/data
    • File inputs: Supply the path and file name or your expression matrix, clinical meta information, and clinical meta feature parameter files
    • Output_Path: Provide a path to write the output files to
    • Immune Deconvolution Methods: Indicate with TRUE or FALSE which methods to run
  • Output
    • Updated clinical meta information and clinical meta feature parameter file which can be used as input to the interactive Shiny app

More Information Here: https://github.com/shawlab-moffitt/PATH-SURVEYOR-Suite/tree/main/1-Getting_Started/3-Immune_Deconvolution

PATH-SURVEYOR: Interactive Mode

  • Script
  • Input
    • Project Name: A descriptive name for your project/data
    • File inputs: Supply the path and file name or your expression matrix, clinical meta information, and clinical meta feature parameter files
    • Advanced User Input
      • Pre-set UI input options to be chosen upon startup, further described in GitHub README
    • Gene Set and Markdown files
      • These are provided files in the GitHub repository. Please ensure the path to these files are correct

More Information Here: https://github.com/shawlab-moffitt/PATH-SURVEYOR-Suite/tree/main/2-PATH-SURVEYOR-Interactive-App

PATH-SURVEYOR: Pipeline Mode

  • Script
  • Input
    • Parameter File: Tab-delimited two-column file containing input file paths and run parameters described in the GitHub 3-PATH-SURVEYOR-Pipeline#parameter-file
      • Pathway Level: When ranking gene set pathways according to Cox proportional hazards, a gene set file and name is required. Users can include a number of top pathways ranked on significance, and a Jaccard connectivity matrix will be included in the output
      • Gene Level: When ranking individual genes, no gene set file is required, though, if one is included, users can select to perform GSEA with a hazard ratio ranked list of genes upon Cox regression completion.
  • Output
    • ssGSEA score table (gene set file required)
    • Median Cut-Point table
    • Cox Proportional Hazard Regression output for all pathways or genes

More Information Here: https://github.com/shawlab-moffitt/PATH-SURVEYOR-Suite/tree/main/3-PATH-SURVEYOR-Pipeline

PATH-SURVEYOR: Pathway Connectivity

  • Script
  • Input
    • Gene Set File:
      • GeneSet_Data/Comprehensive_GeneSet.Rdata
    • User-Derived (Input upon app start-up)
      • CoxPH output file from PATH-SURVEYOR Pipeline pathway analysis
      • CoxPH output file from PATH-SURVEYOR Pipeline gene analysis
  • For gene cluster annotation (Optional)
    • GMT file of gene set pathways is also accepted

More Information Here: https://github.com/shawlab-moffitt/PATH-SURVEYOR-Suite/tree/main/4-Pathway-Connectivity-App

PATH-SURVEYOR: Pre-Ranked Hazard Ratio Ranked GSEA

  • Script
  • Input
    • Gene Set File:
      • GeneSet_Data/GeneSets.zip
    • User-Derived (Input upon app start-up)
      • CoxPH output file from PATH-SURVEYOR Pipeline gene analysis

More Information Here: https://github.com/shawlab-moffitt/PATH-SURVEYOR-Suite/tree/main/5-PreRanked-HazardRatio-GSEA-App

Disclamer

Copyright 2022 Moffitt Cancer Center Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.