| Name | comptg2 JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Telomeric allele scoring tool for output from Telogator2. |
| upload_time | 2024-10-07 16:40:53 |
| maintainer | None |
| docs_url | None |
| author | David Lougheed |
| requires_python | <4.0,>=3.10 |
| license | GPL-3.0 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# `comptg2`
A telomeric allele comparison-scoring tool for output from [Telogator2](https://github.com/zstephens/telogator2).
## Installation
`comptg2` can be installed from PyPI using the following command:
```bash
pip install comptg2
```
## Usage
The following is an example showing how `comptg2` is to be used:
```bash
comptg2 compare ./sample_01_child.tsv ./sample_02_parent_1.tsv ./out.tsv
```
The output matrix can then be plotted using the following command:
```bash
comptg2 plot ./out.tsv
```
## Output Format
**Definition:** TVR = telomere variable region
The output is a TSV matrix with the TVR of the first sample (child) across the
columns, and those of the second sample (parent) across the rows. Each entry in
the matrix is a floating-point number between 0 and 1, representing a custom
similarity score between the two TVRs.
## Copyright Notice
`comptg2` is a telomeric allele comparison-scoring tool for output from
[Telogator2](https://github.com/zstephens/telogator2).
Copyright (C) 2024 McGill University, David Lougheed
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Raw data
{
"_id": null,
"home_page": null,
"name": "comptg2",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "David Lougheed",
"author_email": "david.lougheed@mail.mcgill.ca",
"download_url": "https://files.pythonhosted.org/packages/a3/60/5fbfc1b5131dd1a3c890be4e8531ebbfffb3edbf4be2d9dbd004640f54a0/comptg2-0.2.0.tar.gz",
"platform": null,
"description": "# `comptg2`\n\nA telomeric allele comparison-scoring tool for output from [Telogator2](https://github.com/zstephens/telogator2).\n\n\n## Installation\n\n`comptg2` can be installed from PyPI using the following command:\n\n```bash\npip install comptg2\n```\n\n\n## Usage\n\nThe following is an example showing how `comptg2` is to be used:\n\n```bash\ncomptg2 compare ./sample_01_child.tsv ./sample_02_parent_1.tsv ./out.tsv\n```\n\nThe output matrix can then be plotted using the following command:\n\n```bash\ncomptg2 plot ./out.tsv\n```\n\n\n## Output Format\n\n**Definition:** TVR = telomere variable region\n\nThe output is a TSV matrix with the TVR of the first sample (child) across the \ncolumns, and those of the second sample (parent) across the rows. Each entry in\nthe matrix is a floating-point number between 0 and 1, representing a custom \nsimilarity score between the two TVRs.\n\n\n## Copyright Notice\n\n`comptg2` is a telomeric allele comparison-scoring tool for output from \n[Telogator2](https://github.com/zstephens/telogator2).\n\nCopyright (C) 2024 McGill University, David Lougheed\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program. If not, see <https://www.gnu.org/licenses/>.\n\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Telomeric allele scoring tool for output from Telogator2.",
"version": "0.2.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95e9cdd1e58826905a163b52c4abc8397b0d9d933142d1d056b7a5df85588a13",
"md5": "07d3aa8b861fd3abf3f220323aff91a7",
"sha256": "4257713f8b388b1952a0d17f4ea37989a481619081711f08dfca352d4236042e"
},
"downloads": -1,
"filename": "comptg2-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "07d3aa8b861fd3abf3f220323aff91a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 18263,
"upload_time": "2024-10-07T16:40:52",
"upload_time_iso_8601": "2024-10-07T16:40:52.607319Z",
"url": "https://files.pythonhosted.org/packages/95/e9/cdd1e58826905a163b52c4abc8397b0d9d933142d1d056b7a5df85588a13/comptg2-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3605fbfc1b5131dd1a3c890be4e8531ebbfffb3edbf4be2d9dbd004640f54a0",
"md5": "a66e3ebb843eb3f512751c7a1fb47bed",
"sha256": "9c56e3e0bee193c0c2d42096f4ce4dff96f50208976c2864d573693e81ae6d50"
},
"downloads": -1,
"filename": "comptg2-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a66e3ebb843eb3f512751c7a1fb47bed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 16780,
"upload_time": "2024-10-07T16:40:53",
"upload_time_iso_8601": "2024-10-07T16:40:53.470296Z",
"url": "https://files.pythonhosted.org/packages/a3/60/5fbfc1b5131dd1a3c890be4e8531ebbfffb3edbf4be2d9dbd004640f54a0/comptg2-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 16:40:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "comptg2"
}
