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.2.tar.gz (24.9 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.2-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gffkit-0.2.tar.gz
Algorithm Hash digest
SHA256 8e80ef5a474ce6cd55274fbc651f6a48306ed4541586eecd104e080924dede0c
MD5 8c65aff3b14941e9f14adb923e70ac95
BLAKE2b-256 76ccc2a932b8a3bbb7cd8856b01500941957d4d13e8196a38cf415609c05dc9d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gffkit-0.2-py3-none-any.whl
  • Upload date:
  • Size: 26.2 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 364951087f3da062cbee10769c6743e64c5f2799fd6ac3830c149b55ef92323c
MD5 7ec376c039813b93b50aa1889af51551
BLAKE2b-256 4dd128bee5c291da865cd6728d20750912144028743bb052b52b94c2920d9332

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