| Name | countess-minimap2 JSON |
| Version |
0.0.14
JSON |
| download |
| home_page | None |
| Summary | Sequence Alignment Plugin for CountESS, based in Minimap2 |
| upload_time | 2024-08-27 22:51:03 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# CountESS MiniMap2 Plugin v0.0.14
This is a plugin to allow [MiniMap2](https://github.com/lh3/minimap2)
to be used from within [CountESS](https://github.com/CountESS-Project/CountESS/)
This might be useful, but it also stands as a handy example of how to write
a CountESS plugin which wraps an external Python library.
## Parameters
### Output Column Prefix
The default output column prefix is `mm` but this can be changed.
### Ref FA / Ref MMI
A local FASTA or MMI file to look up the sequences in.
Acceptable formats are MMI or FASTA, optionally gzipped.
### Req Sequence
Alternatively, enter a single reference DNA sequence directly here.
### Preset
See [minimap2 Preset Options](https://lh3.github.io/minimap2/minimap2.html#8)
### Minimum Match Length
Reject matches with an overall length (`mm_r_en - mm_r_st`) less than this.
### Drop Unmatched
Rows with no matches will be dropped.
## Output Columns
### `mm_ctg`
The matched location.
### `mm_r_st`, `mm_r_en`
Start and end positions of the matched sequence.
### `mm_strand`
`1` if query/target on the same strand.
`-1` if opposite.
`0` if unknown.
### `mm_cigar`
CIGAR string expressing the differences within the match. Note that not all differences are
encoded in the CIGAR string, for a more detailed description of what variations are present see
the next two fields.
### `mm_cs`
A difference string as documented in the [Minimap2 Output Format](https://lh3.github.io/minimap2/minimap2.html#10) section.
### `mm_hgvs`
The difference string translated into HGVS format relative to the matched location.
## License
BSD 3-clause. See [LICENSE.txt](LICENSE.txt)
Raw data
{
"_id": null,
"home_page": null,
"name": "countess-minimap2",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Nick Moore <nick@zoic.org>",
"keywords": null,
"author": null,
"author_email": "Nick Moore <nick@zoic.org>",
"download_url": "https://files.pythonhosted.org/packages/07/63/02f2d15ba0d83c8c2970403cd5a76e4c12040636a106bf17e8b2e11c89ab/countess_minimap2-0.0.14.tar.gz",
"platform": null,
"description": "# CountESS MiniMap2 Plugin v0.0.14\n\nThis is a plugin to allow [MiniMap2](https://github.com/lh3/minimap2) \nto be used from within [CountESS](https://github.com/CountESS-Project/CountESS/)\n\nThis might be useful, but it also stands as a handy example of how to write\na CountESS plugin which wraps an external Python library.\n\n## Parameters\n\n### Output Column Prefix\n\nThe default output column prefix is `mm` but this can be changed.\n\n### Ref FA / Ref MMI\n\nA local FASTA or MMI file to look up the sequences in.\nAcceptable formats are MMI or FASTA, optionally gzipped.\n\n### Req Sequence\n\nAlternatively, enter a single reference DNA sequence directly here.\n\n### Preset\n\nSee [minimap2 Preset Options](https://lh3.github.io/minimap2/minimap2.html#8)\n\n### Minimum Match Length\n\nReject matches with an overall length (`mm_r_en - mm_r_st`) less than this.\n\n### Drop Unmatched\n\nRows with no matches will be dropped.\n\n## Output Columns\n\n### `mm_ctg`\n\nThe matched location.\n\n### `mm_r_st`, `mm_r_en`\n\nStart and end positions of the matched sequence.\n\n### `mm_strand`\n\n`1` if query/target on the same strand.\n`-1` if opposite.\n`0` if unknown.\n\n### `mm_cigar`\n\nCIGAR string expressing the differences within the match. Note that not all differences are\nencoded in the CIGAR string, for a more detailed description of what variations are present see\nthe next two fields.\n\n### `mm_cs`\n\nA difference string as documented in the [Minimap2 Output Format](https://lh3.github.io/minimap2/minimap2.html#10) section.\n\n### `mm_hgvs`\n\nThe difference string translated into HGVS format relative to the matched location.\n\n## License\n\nBSD 3-clause. See [LICENSE.txt](LICENSE.txt)\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Sequence Alignment Plugin for CountESS, based in Minimap2",
"version": "0.0.14",
"project_urls": {
"Homepage": "https://github.com/CountESS-Project/countess-minimap2",
"Repository": "https://github.com/CountESS-Project/countess-minimap2.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5431371449d732a9252f834b8cb2a6b332e8964dd3d7a375290ca1a92a5817f1",
"md5": "cdab59fe0fa025f486e6afb560520ce3",
"sha256": "9cc8a22896e05c60a9fdf429dbacf5890560fa39d3acd92d84474b888aa3a0c6"
},
"downloads": -1,
"filename": "countess_minimap2-0.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cdab59fe0fa025f486e6afb560520ce3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 6066,
"upload_time": "2024-08-27T22:51:02",
"upload_time_iso_8601": "2024-08-27T22:51:02.375592Z",
"url": "https://files.pythonhosted.org/packages/54/31/371449d732a9252f834b8cb2a6b332e8964dd3d7a375290ca1a92a5817f1/countess_minimap2-0.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "076302f2d15ba0d83c8c2970403cd5a76e4c12040636a106bf17e8b2e11c89ab",
"md5": "10a81e7d40bc62d3a83b061f2c80a0c0",
"sha256": "814a21a262757176a9493777418dcde9f5167bd8f0c28c1f290d15cb2897f0f9"
},
"downloads": -1,
"filename": "countess_minimap2-0.0.14.tar.gz",
"has_sig": false,
"md5_digest": "10a81e7d40bc62d3a83b061f2c80a0c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 6164,
"upload_time": "2024-08-27T22:51:03",
"upload_time_iso_8601": "2024-08-27T22:51:03.630763Z",
"url": "https://files.pythonhosted.org/packages/07/63/02f2d15ba0d83c8c2970403cd5a76e4c12040636a106bf17e8b2e11c89ab/countess_minimap2-0.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-27 22:51:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CountESS-Project",
"github_project": "countess-minimap2",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "countess-minimap2"
}