/zUMIs

zUMIs: A fast and flexible pipeline to process RNA sequencing data with UMIs

Primary LanguageRGNU General Public License v3.0GPL-3.0

Welcome to zUMIs 🚗💨

zUMIs is a fast and flexible pipeline to process RNA-seq data with UMIs.

The input to this pipeline is paired-end fastq files, where one read contains the cDNA sequence and the other read contains UMI and Cell Barcode information. Furthermore, you will need a STAR index for your genome (see below).

zUMIs Workflow

You can read more about zUMIs in our biorxiv preprint!

You can glance through zUMIs in zUMIs poster!

Releases/Changelog

12 Apr 2018: zUMIs.0.0.6 released. Improved support for combinatorial indexing methods.

30 Mar 2018: zUMIs.0.0.5 released. Rewrote hamming distance binning of UMIs and barcodes. In addition to faster running times, removed dependency on the stringdist package that may have led to issues with parallel computing in some systems. Furthermore removed a possible bug when resuming running with the -w switch in combination with plate barcode usage.

23 Feb 2018: zUMIs.0.0.4 released. Added support for plate barcodes with input of an additional barcode fastq file (eg. Illumina i7 index read). Addition of version number in zUMIs-master. Parameters are printed in a .zUMIs_run.txt file for each call.

18 Feb 2018: zUMIs.0.0.3 released. Switched support to the new Rsubread version and data format. Furthermore to compensate sequencing/PCR errors, zUMIs now features UMI correction using Hamming distance and binning of adjacent cell barcodes.

You can find the older versions of zUMIs here.

Installation and Usage

Please find information on installation and usage in the zUMIs wiki.

Compatibility

zUMIs is compatible with these single-cell UMI protocols:

  • CEL-seq with UMI (Grün et al., 2014)
  • SCRB-seq (Soumillon et al., 2014)
  • MARS-seq (Jaitin et al., 2014)
  • STRT-C1 (Islam et al., 2014)
  • Drop-seq (Macosko et al., 2015)
  • CEL-seq2 (Hashimshony et al., 2016)
  • SORT-seq (Muraro et al., 2016)
  • DroNc-seq (Habib et al., 2017)
  • Seq-Well (Gierahn et al., 2017)
  • SPLiT-seq (Rosenberg et al., 2018)
  • sci-RNA-seq (Cao et al., 2017)
  • STRT-2i (Hochgerner et al., 2018)
  • Quartz-seq2 (Sasagawa et al., 2017)
  • 10x Genomics Chromium (Zheng et al., 2017)
  • Wafergen ICELL8 (Gao et al., 2017)
  • Illumina ddSEQ SureCell
  • inDrops (Zilionis et al., 2017; Klein et al. 2015)

For combinatorial indexing protocols, be sure to check our wiki page.

If you do not find your (favorite) scRNA-seq protocol on the list, get in touch with us!

Getting help

Refer to zUMIs Github wiki for help.

Feel free to contact us on Twitter @swatidparekh and @chris_zie with comments or questions!

Please report bugs 🪲🐛 to the zUMIs Github issue page

If you encounter issues when using zUMIs for the first time, please try to run the example data set included in this repository.