Skip to main content

FinaleToolkit is a package and standalone program to extract fragmentation features of cell-free DNA from paired-end sequencing data.

Project description

dna with letters FT ‎ ‎ ‎FinaleToolkit

Table of Contents

  1. About The Project
  2. Installation
  3. Usage
  4. Contact
  5. License

About The Project

FinaleToolkit (FragmentatIoN AnaLysis of cEll-free DNA Toolkit) is a package and standalone program to extract fragmentation features of cell-free DNA from paired-end sequencing data.

Citation

If you use FinaleToolkit in your research, please consider citing our paper:

James Wenhan Li, Ravi Bandaru, Kundan Baliga, Yaping Liu, FinaleToolkit: Accelerating Cell-Free DNA Fragmentation Analysis with a High-Speed Computational Toolkit, Bioinformatics Advances, 2025;, vbaf236, https://doi.org/10.1093/bioadv/vbaf236

Installation

You can install the package using conda.

$ conda install -c bioconda -c conda-forge finaletoolkit

You can also install the package using pip.

$ pip install finaletoolkit

Usage

Functionality

FinaleToolkit has support for the following cell-free DNA fragmentation features:

  • Fragment Length
  • Coverage
  • End Motifs DOI
  • Motif Diversity Score DOI
  • Windowed Protection Score DOI
  • DELFI DOI
  • Cleavage Profile DOI

Documentation

Documentation for FinaleToolkit can be found here.

Wiki/Tutorials

The wiki and tutorial page for FinaleToolkit can be found here.

Compatible File Formats

FinaleToolkit is compatible with almost any paired-end sequence data:

  • Binary Alignment Map (.bam) files with an associated index file (.bam.bai).
  • Compressed Reference-oriented Alignment Map (.cram) files.
  • Fragment (.frag.gz) files with an associated tabix index file (.frag.gz.tbi).

Using Fragment Files

Fragment (.frag.gz) files are block-gzipped BED3+2 files with the following columns: chrom , start , stop , mapq , strand.

We encourage you to use our comprehensive database, FinaleDB, to access relevant fragment files. Learn more about FinaleDB here.

Snakemake workflow

Check out our Snakemake workflow!

Contact

License

This project falls under an MIT license. See the included LICENSE file for details.

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

finaletoolkit-0.11.1.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

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

finaletoolkit-0.11.1-py3-none-any.whl (95.1 kB view details)

Uploaded Python 3

File details

Details for the file finaletoolkit-0.11.1.tar.gz.

File metadata

  • Download URL: finaletoolkit-0.11.1.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for finaletoolkit-0.11.1.tar.gz
Algorithm Hash digest
SHA256 eeb23f50fad1666b66aa2d22c16075c9c06d4788506792367d16794d8f9b9893
MD5 e204566f4c6dcd4a2154dc8220e1550d
BLAKE2b-256 60a9943424b45539dbd0cf101f625888ee8ce2d87a955bd7d0dd440ba606d2e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for finaletoolkit-0.11.1.tar.gz:

Publisher: python-publish.yml on epifluidlab/FinaleToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file finaletoolkit-0.11.1-py3-none-any.whl.

File metadata

  • Download URL: finaletoolkit-0.11.1-py3-none-any.whl
  • Upload date:
  • Size: 95.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for finaletoolkit-0.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6832d55248d48ab0acbb63a6ef4d34d5afbb185736c62e8d396e52961c9e785c
MD5 3b8d8ba28a955f8611be8fb8be515b76
BLAKE2b-256 cb569308452dc74fcdf5b3e0356a75a58aa9ad1f8ad2db4a828935f9370ca231

See more details on using hashes here.

Provenance

The following attestation bundles were made for finaletoolkit-0.11.1-py3-none-any.whl:

Publisher: python-publish.yml on epifluidlab/FinaleToolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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