Skip to main content

Region-aware GFF annotation integration toolkit

Project description

gffkit

gffkit is a lightweight toolkit for region-aware GFF/GTF annotation integration. It combines three utilities:

  1. detect-bridge: detect suspicious merged-gene artifacts caused by bridge transcripts.
  2. complement: complement/merge annotations, with optional region-swap mode.
  3. add-utr: reconstruct five_prime_UTR and three_prime_UTR features from exon/CDS coordinates.

Installation

pip install gffkit

Quick start

Full integration pipeline

gffkit integrate \
  --annotation-a EviAnn.gff3 \
  --annotation-b ANNEVO.gff3 \
  --outdir gffkit_out \
  --prefix sample

Outputs:

  • gffkit_out/sample.suspicious.tsv
  • gffkit_out/sample.merged.gff3
  • gffkit_out/sample.final.withUTR.gff3

Step-by-step usage

# 1. Detect suspicious merged genes in Annotation A
gffkit detect-bridge -i EviAnn.gff3 -o suspicious.tsv

# 2. Use A as the global reference, but switch to B in suspicious regions
gffkit complement \
  --ref EviAnn.gff3 \
  --add ANNEVO.gff3 \
  --swap_region_tsv suspicious.tsv \
  --swap_region_flank 100 \
  --output merged.gff3

# 3. Add UTR features
gffkit add-utr -i merged.gff3 -o final.annotation.withUTR.gff3

Command overview

gffkit --help
gffkit detect-bridge --help
gffkit complement --help
gffkit add-utr --help
gffkit integrate --help

Annotation integration strategy

  • Annotation A, for example EviAnn/RNA-seq-supported GFF, is used as the global primary reference.
  • Annotation B, for example ANNEVO/deep-learning GFF, is used as the local primary reference only in suspicious merged-gene regions.
  • UTR features are reconstructed after merging using an exon-minus-CDS strategy.

License

MIT License.

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

gffkit-0.3.tar.gz (25.4 kB view details)

Uploaded Source

Built Distribution

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

gffkit-0.3-py3-none-any.whl (26.9 kB view details)

Uploaded Python 3

File details

Details for the file gffkit-0.3.tar.gz.

File metadata

  • Download URL: gffkit-0.3.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.12

File hashes

Hashes for gffkit-0.3.tar.gz
Algorithm Hash digest
SHA256 574642043376f5b334df5203261fcd17da5ee33669ad91ed0d37550122fef230
MD5 3ea4c359c06e34fb66013bf7c0939095
BLAKE2b-256 150dfaa23efbb2227a2b80eecd7ce377281f52171560e0da19ac8fa7d2d5bfb5

See more details on using hashes here.

File details

Details for the file gffkit-0.3-py3-none-any.whl.

File metadata

  • Download URL: gffkit-0.3-py3-none-any.whl
  • Upload date:
  • Size: 26.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.12

File hashes

Hashes for gffkit-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 89b85b9f8c375d16ecd9c6738a0eb6b2a96f201581dfc003eebf161885fe7e70
MD5 1e074bf1e9b3d1678b274af0bb167605
BLAKE2b-256 942ce3ca202f23d16847779116d45a201261577fa42823e988df185507765ee8

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