Skip to main content

Genomic data processing toolkit

Project description

csplice

Genomic data processing toolkit for converting GTF to BED format and analyzing BAM gene overlaps.

Installation

# Install from PyPI
pip install csplice

# Or install from source
pip install .

Usage

gtf2bed command

Convert GTF to BED files:

csplice gtf2bed -g input.gtf -o output_dir

This will generate 4 BED files in the output directory:

  • gene.bed: Standard 6-column BED format (chrom, start, end, gene_id, gene_name, strand)
  • transcript.bed: Standard 6-column BED format (chrom, start, end, transcript_id, gene_id, strand)
  • exon.bed: Standard 6-column BED format (chrom, start, end, transcript_id, gene_id, strand)
  • intron.bed: Standard 6-column BED format (chrom, start, end, transcript_id, gene_id, strand)

bam2gene command

Analyze BAM file gene overlaps:

csplice bam2gene -b input.bam -g genes.bed -o output_dir

This will generate 2 files in the output directory:

  • splice.txt: TSV format with columns (barcode, umi, gene_id, gene_name), reads with out intron
  • unsplice.txt: TSV format with columns (barcode, umi, gene_id, gene_name), reads with intron

Options

gtf2bed

Options:
  -g, --gtf TEXT         Input GTF file path  [required]
  -o, --outdir TEXT      Output directory  [required]
  -i, --gene_id TEXT     Gene ID key in attributes  [default: gene_id]
  -n, --gene_name TEXT   Gene name key in attributes  [default: gene_name]
  -t, --transcript_id TEXT  Transcript ID key in attributes  [default: transcript_id]
  --help                 Show this message and exit.

bam2gene

Options:
  -b, --bam TEXT         Input BAM file path  [required]
  -o, --outdir TEXT      Output directory  [required]
  -g, --genebed TEXT     Gene BED file path  [required]
  -i, --introned TEXT    Intron BED file path  [required]
  -c, --cb TEXT          Cell barcode tag (default: CB)
  -u, --ub TEXT          UMI tag (default: UB)
  --help                 Show this message and exit.

Development

# Install dev dependencies
poetry install --with dev

# Run tests
poetry run pytest

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

csplice-0.1.7.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

csplice-0.1.7-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file csplice-0.1.7.tar.gz.

File metadata

  • Download URL: csplice-0.1.7.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for csplice-0.1.7.tar.gz
Algorithm Hash digest
SHA256 4b893d470ab2afbe641d4da1a9c8967d65fc99622b16c8246a2590361d4de59c
MD5 2c29084c2025cda1ac911e038f7bb7d3
BLAKE2b-256 4fcc9e81ac8096b28809245de89fad03cd6f76d90bf2180fd081d9f92ccb83e9

See more details on using hashes here.

File details

Details for the file csplice-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: csplice-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for csplice-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4c644807aa7a5e17dbc48f26e047e57bb747f387986fd27f20f40daf9ac18a90
MD5 d3ceffaf3baa3754e29732f7ecf482b6
BLAKE2b-256 7298f5c8ec86fe2740feb170fd7712a15b0ee26fb0f4418880de51b32a370378

See more details on using hashes here.

Supported by

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