| Name | FinaleToolkit JSON |
| Version |
0.10.1
JSON |
| download |
| home_page | None |
| Summary | FinaleToolkit is a package and standalone program to extract fragmentation features of cell-free DNA from paired-end sequencing data. |
| upload_time | 2024-12-19 17:04:48 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 EpiFluidLab Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
bioinformatics
cell free dna
computational biology
genomics
epigenomics
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# <img alt="dna with letters FT" src="https://bananasrlowkeygood.github.io/images/finaletools_logo_rounded.png" height="60"> FinaleToolkit
<summary><h3>Table of Contents</h2></summary>
<ol>
<li><a href="#about-the-project">About The Project</a></li>
<li><a href="#installation">Installation</a></li>
<li>
<a href="#usage">Usage</a>
<ul>
<li><a href="#functionality">Functionality</a></li>
<li><a href="#documentation">Documentation</a></li>
<li><a href="#wiki">Wiki/Tutorials</a></li>
<li><a href="#compatible-file-formats">Compatible File Formats</a></li>
<li><a href="#using-fragment-files">Using Fragment Files</a></li>
</ul>
</li>
<li><a href="#contact">Contact</a></li>
<li><a href="#license">License</a></li>
</ol>
## About The Project
FinaleToolkit (**F**ragmentat**I**o**N** **A**na**L**ysis of c**E**ll-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:
[](https://doi.org/10.1101/2024.05.29.596414)
## 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 [](https://doi.org/10.1158/2159-8290.cd-19-0622)
- Motif Diversity Score [](https://doi.org/10.1158/2159-8290.CD-19-0622)
- Windowed Protection Score [](https://doi.org/10.1016/j.cell.2015.11.050)
- DELFI [](https://doi.org/10.1038%2Fs41586-019-1272-6)
- Cleavage Profile [](https://doi.org/10.1073/pnas.2209852119)
### Documentation
Documentation for FinaleToolkit can be found [here](https://epifluidlab.github.io/finaletoolkit-docs/).
### Wiki/Tutorials
The wiki and tutorial page for FinaleToolkit can be found [here](https://github.com/epifluidlab/FinaleToolkit/wiki).
### 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](http://finaledb.research.cchmc.org).
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "FinaleToolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "bioinformatics, cell free DNA, computational biology, genomics, epigenomics",
"author": null,
"author_email": "James Li <lijw21@wfu.edu>, Ravi Bandaru <ravi.bandaru@northwestern.edu>, Yaping Liu <yaping@northwestern.edu>",
"download_url": "https://files.pythonhosted.org/packages/ea/0d/1250111199e4645174719174381236951e7c03aaa3c84db84bee8c63b97e/finaletoolkit-0.10.1.tar.gz",
"platform": null,
"description": "# <img alt=\"dna with letters FT\" src=\"https://bananasrlowkeygood.github.io/images/finaletools_logo_rounded.png\" height=\"60\"> \u200e \u200e \u200eFinaleToolkit\n<summary><h3>Table of Contents</h2></summary>\n<ol>\n <li><a href=\"#about-the-project\">About The Project</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n <li>\n <a href=\"#usage\">Usage</a>\n <ul>\n <li><a href=\"#functionality\">Functionality</a></li>\n <li><a href=\"#documentation\">Documentation</a></li>\n <li><a href=\"#wiki\">Wiki/Tutorials</a></li>\n <li><a href=\"#compatible-file-formats\">Compatible File Formats</a></li>\n <li><a href=\"#using-fragment-files\">Using Fragment Files</a></li>\n </ul>\n </li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#license\">License</a></li>\n</ol>\n\n\n\n\n## About The Project\nFinaleToolkit (**F**ragmentat**I**o**N** **A**na**L**ysis of c**E**ll-free DNA \n**Toolkit**) is a package and standalone program to extract fragmentation\nfeatures of cell-free DNA from paired-end sequencing data.\n\n### Citation\nIf you use FinaleToolkit in your research, please consider citing our paper:\n\n[](https://doi.org/10.1101/2024.05.29.596414)\n\n\n## Installation\nYou can install the package using `pip`.\n```\n$ pip install finaletoolkit\n```\n\n## Usage\n\n### Functionality\n\nFinaleToolkit has support for the following cell-free DNA fragmentation features:\n\n- Fragment Length\n- Coverage\n- End Motifs [](https://doi.org/10.1158/2159-8290.cd-19-0622)\n- Motif Diversity Score [](https://doi.org/10.1158/2159-8290.CD-19-0622)\n- Windowed Protection Score [](https://doi.org/10.1016/j.cell.2015.11.050)\n- DELFI [](https://doi.org/10.1038%2Fs41586-019-1272-6)\n- Cleavage Profile [](https://doi.org/10.1073/pnas.2209852119)\n\n### Documentation\nDocumentation for FinaleToolkit can be found [here](https://epifluidlab.github.io/finaletoolkit-docs/).\n\n### Wiki/Tutorials\nThe wiki and tutorial page for FinaleToolkit can be found [here](https://github.com/epifluidlab/FinaleToolkit/wiki).\n\n### Compatible File Formats\n\nFinaleToolkit is compatible with almost any paired-end sequence data:\n\n- Binary Alignment Map (`.bam`) files with an associated index file (`.bam.bai`).\n- Compressed Reference-oriented Alignment Map (`.cram`) files.\n- Fragment (`.frag.gz`) files with an associated tabix index file (`.frag.gz.tbi`).\n\n### Using Fragment Files\n\nFragment (`.frag.gz`) files are block-gzipped BED3+2 files with the following columns: `chrom` , `start` , `stop` , `mapq` , `strand`.\n\nWe encourage you to use our comprehensive database, FinaleDB, to access relevant fragment files. Learn more about FinaleDB [here](http://finaledb.research.cchmc.org).\n\n## Contact\n- James Li: lijw21@wfu.edu\n- Ravi Bandaru: ravi.bandaru@northwestern.edu\n- Yaping Liu: yaping@northwestern.edu\n\n## License\nThis project falls under an MIT license. See the included `LICENSE` file for details.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 EpiFluidLab Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "FinaleToolkit is a package and standalone program to extract fragmentation features of cell-free DNA from paired-end sequencing data.",
"version": "0.10.1",
"project_urls": {
"Changelog": "https://github.com/epifluidlab/FinaleToolkit/blob/main/CHANGELOG.md",
"Homepage": "https://epifluidlab.github.io/FinaleToolkit/",
"Issues": "https://github.com/epifluidlab/FinaleToolkit/issues",
"Lab Website": "https://epifluidlab.github.io/",
"Repository": "https://github.com/epifluidlab/finaletoolkit",
"Wiki": "https://github.com/epifluidlab/FinaleToolkit/wiki"
},
"split_keywords": [
"bioinformatics",
" cell free dna",
" computational biology",
" genomics",
" epigenomics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "02f92f6ceb7077fc56c2c86ec97c327a520cd2682e8ccda880deb5ff55cf3d44",
"md5": "1b336088914c7fc10a479d0fd070855b",
"sha256": "bdce1bab005678990b59a33f00ab86621234263dc0f12cba5535aab1aa2b37af"
},
"downloads": -1,
"filename": "FinaleToolkit-0.10.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b336088914c7fc10a479d0fd070855b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 83599,
"upload_time": "2024-12-19T17:04:45",
"upload_time_iso_8601": "2024-12-19T17:04:45.302417Z",
"url": "https://files.pythonhosted.org/packages/02/f9/2f6ceb7077fc56c2c86ec97c327a520cd2682e8ccda880deb5ff55cf3d44/FinaleToolkit-0.10.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ea0d1250111199e4645174719174381236951e7c03aaa3c84db84bee8c63b97e",
"md5": "c754fe1fd1360108d42069f963c11290",
"sha256": "1a83796c4b9bf8967046a1b4df1979899f67d662e71a64cd49311fe3d68d6a7e"
},
"downloads": -1,
"filename": "finaletoolkit-0.10.1.tar.gz",
"has_sig": false,
"md5_digest": "c754fe1fd1360108d42069f963c11290",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 81531,
"upload_time": "2024-12-19T17:04:48",
"upload_time_iso_8601": "2024-12-19T17:04:48.009789Z",
"url": "https://files.pythonhosted.org/packages/ea/0d/1250111199e4645174719174381236951e7c03aaa3c84db84bee8c63b97e/finaletoolkit-0.10.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 17:04:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "epifluidlab",
"github_project": "FinaleToolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "finaletoolkit"
}
