Skip to main content

Extracting single cell variants from bam file

Project description

Mutract

Mutract is a tool for extracting single cell variants from bam file. If vcf file is not provided, it will perform variant calling at single cell level.

Requirements

  • python > 3.6
  • GATK
  • samtools

Installation

pip install mutract

GATK and samtools can be installed via conda.

Usage

mutract \
--bam bam_file \
--barcodes cell_barcodes_file \
--fasta reference_fasta_file \
--vcf vcf_file \
--sample sample_name \
--outdir output_directory \
--thread 8 \
--gene_file gene_file \
  • Required Arguments

bam Input CeleScope BAM file. If gene_file is specified, the BAM must have the 'GN' tag.

barcodes Cell barcodes file, one barcode per line.

fasta Reference genome fasta, must be indexed.

sample Sample name.

  • Optional Arguments

vcf VCF file. If vcf file is not provided, mutract will perform variant calling at single cell level and use these variants as input vcf.

outdir Output directory, default='./'.

thread The number of threads to use, default=1.

gene_file Gene list file, one gene symbol per line. Only variants of these genes are reported.

Output

{sample}_VID.tsv A unique numeric ID is assigned for each variant.

{sample}_CID.tsv A unique numeric ID is assigned for each cell.

{sample}_variant_count.tsv Reference and variant supporting reads/UMIs count.

{sample}_support.mtx Support matrix, only high quality bases are considered.
0 : no reads/UMIs cover the position.
1 : all reads/UMIs at the position support the ref allele.
2 : all reads/UMIs at the position support the alt allele.
3 : one or more reads/UMIs support both the alt and the ref allele.

Project details


Download files

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

Source Distribution

mutract-1.1.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

mutract-1.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file mutract-1.1.tar.gz.

File metadata

  • Download URL: mutract-1.1.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for mutract-1.1.tar.gz
Algorithm Hash digest
SHA256 92f61a4098c4aeeec5098bb516a2b49a6d314d63d9886102109370f26841bc08
MD5 466753bd854dd082e325a14b93c02bd0
BLAKE2b-256 c6d4596b03e052ae131e0dcd4aeb6cf74ea2b81964bde204740f7c56a162e02a

See more details on using hashes here.

File details

Details for the file mutract-1.1-py3-none-any.whl.

File metadata

  • Download URL: mutract-1.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.6.7

File hashes

Hashes for mutract-1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 db19274f1d8b62daeac231b914143b8d961f7d07e243f25d6714940be32201f8
MD5 3e0148a4b87945aa2ec769ae55b9db4d
BLAKE2b-256 61a6002e82d87834e25758dbf8ce7484c67f6050ff90dd8432ff4417c4f593d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page