Skip to content

A Snakemake pipeline for identifying viruses from single-cell data.

Notifications You must be signed in to change notification settings

maxplanck-ie/sc-VirusScan

Repository files navigation

scVirusScan: A method for swift and accurate detection of viral pathogens in single-cell RNA datasets

Snakemake

sc-VirusScan is a method that enables accurate, sensitive and scalable detection of viral pathogens in single-cell RNA datasets.

The sc-VirusScan integrates the strengths of two standard approaches, a standard mapping based approach and a Kraken2 k-mer based approach which provides rapid taxonomic classification. The output of the sc-VirusScan pipeline can be integrated easily into existing single cell analysis frameworks (Seurat and Scanpy) which can provide standardized and reliable way to scrutinize virus infections at the single cell level resolution.


Installation and Setup

sc-VirusScan by installed by following the below mentioned steps.

  1. Clone the Git Repository using: git clone https://github.com/maxplanck-ie/sc-VirusScan.git

  2. Change the directory to sc-virus-scan: cd sc-VirusScan

  3. The dependecies of sc-VirusScan can be installed from the provided env.yaml by using conda/mamba

    mamba env create -f env.yaml -n sc-VirusScan

  4. Additionally, this pipeline needs CellRanger tool. To install CellRanger please refer to https://support.10xgenomics.com/single-cell-gene-expression/software/pipelines/latest/installation

  5. Upon successfull installation of CellRanger, the CellRanger path needs to be updated in the config.yaml file accordingly

  6. Lastly, the config.yaml needs to be modified as per your system environment variables. More information about config.yaml along with its description can be found in the Read the docs page.


Documentation

For detailed documentation on setup and usage, please visit our Read the docs page.


Credits

sc-VirusScan was developed by Saim Momin as a Master Thesis project for the Bioinformatics Master program of the Saarland University, under the supervision of Deboutte W and Manke T. at the Bioinformatics Unit of the Max Planck Institute for Immunobiology and Epigenetics in Freiburg.

MPI_Logo


Help and Support

sc-VirusScan pipeline is under active development. Please use issues to the GitHub repository for feature requests or bug reports.

About

A Snakemake pipeline for identifying viruses from single-cell data.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published