# surpyvor
A python wrapper around [SURVIVOR](https://github.com/fritzsedlazeck/SURVIVOR), with additional convenience functions.
## Installation and dependencies
surpyvor requires bcftools, bgzip, tabix and SURVIVOR to be installed and in the $PATH.
Required python modules are cyvcf2, matplotlib, numpy, matplotlib-venn and upsetplot
surpyvor and its dependencies can be installed from [bioconda](https://anaconda.org/bioconda/surpyvor):
`conda install -c bioconda surpyvor`
## USAGE
### sub-commands:
merge merging vcf files of SVs
highsens get union of SV vcfs
highconf get intersection of SV vcfs
prf calculate precision, recall and F-measure
upset Make upset plot for multiple SV vcf files
venn Make venn diagram for 2 or 3 SV vcf files
Each sub-command has its own help information, accessible by running `surpyvor <command> -h/--help`
### General and common arguments for most sub-commands:
```
-o/--output: output variant file to write. Default: stdout
--plotout: name ouf output plot to write. Default names depending on plot type.
-d/--distance: maximal pairwise distance between coordinates of SVs to be considered concordant. Default: 500
-l/--minlength: minimal SV length to include. Default: 50
--variants: vcf files to combine
```
### Specific arguments
#### surpyvor prf
```
--ignore_chroms: ignore some chromosomes for calculations. Default: chrEBV
--bar: create a stacked bar chart colored by validation status [not created by default]
--matrix: create a confusion matrix [not created by default]
```
## Citation
If you use this tool, please consider citing our [publication](https://genome.cshlp.org/content/early/2019/06/11/gr.244939.118.abstract) and the [citation for SURVIVOR](https://www.nature.com/articles/ncomms14061).
Raw data
{
"_id": null,
"home_page": "https://github.com/wdecoster/surpyvor",
"name": "surpyvor",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": "",
"keywords": "nanopore",
"author": "Wouter De Coster",
"author_email": "decosterwouter@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/a7/ed/873bd93782ef72b059cee18e4e06f1e00b383883daa716475f8829182a85/surpyvor-0.15.0.tar.gz",
"platform": null,
"description": "# surpyvor\nA python wrapper around [SURVIVOR](https://github.com/fritzsedlazeck/SURVIVOR), with additional convenience functions.\n\n## Installation and dependencies\nsurpyvor requires bcftools, bgzip, tabix and SURVIVOR to be installed and in the $PATH.\nRequired python modules are cyvcf2, matplotlib, numpy, matplotlib-venn and upsetplot\n\nsurpyvor and its dependencies can be installed from [bioconda](https://anaconda.org/bioconda/surpyvor):\n\n`conda install -c bioconda surpyvor`\n\n## USAGE\n### sub-commands:\n merge merging vcf files of SVs\n highsens get union of SV vcfs\n highconf get intersection of SV vcfs\n prf calculate precision, recall and F-measure\n upset Make upset plot for multiple SV vcf files\n venn Make venn diagram for 2 or 3 SV vcf files\n\nEach sub-command has its own help information, accessible by running `surpyvor <command> -h/--help`\n\n### General and common arguments for most sub-commands:\n```\n-o/--output: output variant file to write. Default: stdout\n--plotout: name ouf output plot to write. Default names depending on plot type.\n-d/--distance: maximal pairwise distance between coordinates of SVs to be considered concordant. Default: 500\n-l/--minlength: minimal SV length to include. Default: 50\n--variants: vcf files to combine\n```\n\n### Specific arguments\n\n#### surpyvor prf\n```\n--ignore_chroms: ignore some chromosomes for calculations. Default: chrEBV\n--bar: create a stacked bar chart colored by validation status [not created by default]\n--matrix: create a confusion matrix [not created by default]\n```\n\n## Citation\nIf you use this tool, please consider citing our [publication](https://genome.cshlp.org/content/early/2019/06/11/gr.244939.118.abstract) and the [citation for SURVIVOR](https://www.nature.com/articles/ncomms14061).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Manipulate vcf files of structural variants using SURVIVOR",
"version": "0.15.0",
"project_urls": {
"Homepage": "https://github.com/wdecoster/surpyvor"
},
"split_keywords": [
"nanopore"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7ed873bd93782ef72b059cee18e4e06f1e00b383883daa716475f8829182a85",
"md5": "a607f35939dd6bcb52a16429faf47dbe",
"sha256": "da22dcf7a03c59325d3bddc53e3e6e8c335b1758cff093257e4d3b073eb01470"
},
"downloads": -1,
"filename": "surpyvor-0.15.0.tar.gz",
"has_sig": false,
"md5_digest": "a607f35939dd6bcb52a16429faf47dbe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 16146,
"upload_time": "2023-06-23T14:12:40",
"upload_time_iso_8601": "2023-06-23T14:12:40.256461Z",
"url": "https://files.pythonhosted.org/packages/a7/ed/873bd93782ef72b059cee18e4e06f1e00b383883daa716475f8829182a85/surpyvor-0.15.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-23 14:12:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "wdecoster",
"github_project": "surpyvor",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "surpyvor"
}
JSON
