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
Metadata
Release files for csplice 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| csplice-0.2.0.tar.gz | 5.1 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| csplice-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.0 kB
Release files / csplice-0.2.0.tar.gz
| Download URL | csplice-0.2.0.tar.gz |
|---|---|
| Size | 5.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5639d02324f0b83b7c52b3df00463b370f943b5cbc1a853322fe4c97aecfb508
|
|
BLAKE2b-256 checksum How to use checksums |
25287a598b4b5fa4a25eb3b07438d2e75e9c908a9b9d8d00b183aa85f52e93bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / csplice-0.2.0-py3-none-any.whl
| Download URL | csplice-0.2.0-py3-none-any.whl |
|---|---|
| Size | 6.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
aba44e2e6ef8c4b5d65977f2acf2dae0a02790377473b9142fcc6bffe92d8dbf
|
|
BLAKE2b-256 checksum How to use checksums |
56b357379a0a64c43805c33f42e5db30ea4b7ebb196025fdb304aa7f72ddd96f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Security for csplice 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.