FinaleToolkit
Table of Contents
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
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
- Motif Diversity Score
- Windowed Protection Score
- DELFI
- Cleavage Profile
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
- James Li: lijw21@wfu.edu
- Ravi Bandaru: ravi.bandaru@northwestern.edu
- Yaping Liu: yaping@northwestern.edu
License
This project falls under an MIT license. See the included LICENSE file for details.
Metadata
Release files for FinaleToolkit 0.10.6
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 | Actions |
|---|---|---|---|---|
| finaletoolkit-0.10.6.tar.gz | 83.2 kB | With provenance | Details for finaletoolkit-0.10.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| FinaleToolkit-0.10.6-py3-none-any.whl | Python 3 | none | any | Details for FinaleToolkit-0.10.6-py3-none-any.whl |
Total release size: 168.8 kB
Release files / finaletoolkit-0.10.6.tar.gz
| Download URL | finaletoolkit-0.10.6.tar.gz |
|---|---|
| Size | 83.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
86ff8ef3e25d337855b0f246f49b810c8974137c9de4f57055bea80f242f04b1
|
|
BLAKE2b-256 checksum How to use checksums |
2b7d4923e8341409894ac198c671dcef1ffa82189e133cf2523f7fdda9556ac7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 15, 2025.
Transparency logRelease files / FinaleToolkit-0.10.6-py3-none-any.whl
| Download URL | FinaleToolkit-0.10.6-py3-none-any.whl |
|---|---|
| Size | 85.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3dd23234f4e95a8738a3340b8653520d9258ebee663e060a1b86547fb8a17048
|
|
BLAKE2b-256 checksum How to use checksums |
b31aa9224bf18aac374c313ac0bd37ab9e114c4a8049fb4a4c7e9c68a1e8a04b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 15, 2025.
Transparency logSecurity for FinaleToolkit 0.10.6
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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for finaletoolkit-0.10.6.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 15, 2025.
Transparency logA 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.