Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A package for de-barcoding and error correction of sequencing data containing molecular barcodes.

Project description

A package for De-Barcoding and Error Correction of sequencing data containing molecular barcodes. For information on getting started with Debarcer, see the Installation Guide.

Note : The repository for the original release of Debarcer (V0.3.1) as described in Nature Protocols can be found under https://github.com/oicr-gsi/debarcer/releases/tag/v0.3.1

https://github.com/oicr-gsi/debarcer/tree/master-old

Configuration

A sample config file is provided in /debarcer/config/sample_config.ini, and a sample prepfile is provided in /debarcer/config/library_prep_types.ini. Thresholds and paths that you expect to use multiple times should be stored in the config file. The prepfile contains instructions for how different library preps should be handled, for example:

; One library entry
[LIBRARY_NAME]
INPUT_READS=3
OUTPUT_READS=2
UMI_LOCS=2
UMI_LENS=10
SPACER=FALSE
  • INPUT_READS:
    Number of unprocessed fastq files (1-3).
  • OUTPUT_READS:
    Number of fastq files after reheadering (1-2).
  • UMI_LOCS:
    Comma-separated indices of reads containing a UMI (1-3).
  • UMI_LENS:
    Comma-separated lengths of UMIs corresponding to UMI_LOCS (1-100).
  • SPACER:
    TRUE if a spacer is present, FALSE otherwise (TRUE/FALSE).
  • SPACER_SEQ (optional):
    Base sequence of the spacer ([A,C,G,T]+).

LIBRARY_NAME would then be the --prepname argument passed to debarcer.py.

Typical Workflow

## Preprocess some fastq files
$ python debarcer.py preprocess -o /path/to/output_dir -r1 /path/to/read1.fastq -r2 /path/to/read2.fastq
  -prepname "prepname" -prepfile /path/to/library_prep_types.ini

## Align, sort, index
## ...
## produces: bam_file.bam, bam_file.bam.bai

## Error-correct and group UMIs into families
$ python debarcer.py group -r chrN:posA-posB -c /path/to/config.ini -b /path/to/bam_file.bam
  -o /path/to/output_dir

## Perform base collapsing
$ python debarcer.py collapse -o /path/to/output_dir -r chrN:posA-posB
  -b /path/to/bam_file.bam -u /path/to/umi_file.umis
  -c /path/to/config.ini

## Call variants of specified family sizes
$ python debarcer.py call -o /path/to/output_dir -r chrN:posA-posB
  -cf /path/to/cons_file.cons -f 1,2,5 -c path/to/config.ini

Dependencies

Debarcer was tested using Python 3.6.4 and depends on the packages pysam and pandas. See requirements.txt.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for debarcer, version 2.0.3
Filename, size File type Python version Upload date Hashes
Filename, size debarcer-2.0.3-py3-none-any.whl (35.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size debarcer-2.0.3.tar.gz (27.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page