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:

Li J*, Bandaru R*, Liu Y (2024) FinaleToolkit: Accelerating Cell-Free DNA Fragmentation Analysis with a High-Speed Computational Toolkit. BioRxiv Preprint Static Badge

Installation

You can 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.

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.10.6.tar.gz (83.2 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.10.6-py3-none-any.whl (85.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: finaletoolkit-0.10.6.tar.gz
  • Upload date:
  • Size: 83.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for finaletoolkit-0.10.6.tar.gz
Algorithm Hash digest
SHA256 86ff8ef3e25d337855b0f246f49b810c8974137c9de4f57055bea80f242f04b1
MD5 21f21a0835f67b1c08c7500884c037d6
BLAKE2b-256 2b7d4923e8341409894ac198c671dcef1ffa82189e133cf2523f7fdda9556ac7

See more details on using hashes here.

Provenance

The following attestation bundles were made for finaletoolkit-0.10.6.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.10.6-py3-none-any.whl.

File metadata

  • Download URL: FinaleToolkit-0.10.6-py3-none-any.whl
  • Upload date:
  • Size: 85.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for FinaleToolkit-0.10.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3dd23234f4e95a8738a3340b8653520d9258ebee663e060a1b86547fb8a17048
MD5 e8df6c330205d2f7446f409d3aa1f07d
BLAKE2b-256 b31aa9224bf18aac374c313ac0bd37ab9e114c4a8049fb4a4c7e9c68a1e8a04b

See more details on using hashes here.

Provenance

The following attestation bundles were made for FinaleToolkit-0.10.6-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