Skip to content

griffithlab/ImmunoNX_protocol

 
 

Repository files navigation

ImmunoNX Protocol

License

This repository contains the protocol and supporting materials for the ImmunoNX pipeline, a comprehensive workflow for predicting neoantigens. The manuscript (linked below) describes our computational pipeline (ImmunoNX) and rigorous manual immunogenomics review criteria for designing neoantigen vaccines. We also describe how to run the pipeline for an example HCC1395 cell line, and provide materials from our immunogenomics review of that cell line.

Manuscript

Link to the manuscript: arXiv preprint

Link to supplementary files: Zenodo

Repository Contents

Documentation

  • Preparing_references.md: Instructions for preparing the reference bundle required for the pipeline.
  • RunningPipeline_README.md: Step-by-step guide to running the Google Cloud implementation of the ImmunoNX pipeline using WDL workflows and Google Cloud Helper scripts.
  • ManualReview_README.md: Guidelines for quality control checks and manual review of pipeline results to pick neoantigen candidates for a vaccine design (or other downstream experiments).
  • Troubleshooting_README.md: Addresses common issues encountered during pipeline execution and manual review.

Configuration and Examples

  • example_yamls/:
    • template_immuno_local-WDL.yaml: Example configuration YAML file for running the pipeline.

External repositories referenced or used by the pipeline

  • analysis-wdls repository: The WDL files in this repo contain the necessary instructions for running the ImmunoNX pipeline.
  • cloud-workflows repository: Contains the Google Cloud Helper scripts that enable users to set up their Google Cloud account, storage bucket, and virtual machine (VM) in order to execute the ImmunoNX pipeline.

License

  • LICENSE: MIT License for this repository.

Citation

If you use this protocol in your research, please cite our manuscript arXiv preprint

Contact

For questions or issues, please open an issue on this GitHub repository.

About

Tutorial for running immuno.wdl on Google Cloud

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published