surpyvor
A python wrapper around 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:
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 and the citation for SURVIVOR.
Metadata
Release files for surpyvor 0.15.0
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 |
|---|---|---|---|---|
| surpyvor-0.15.0.tar.gz | 16.1 kB | Without provenance | Details for surpyvor-0.15.0.tar.gz |
Release files / surpyvor-0.15.0.tar.gz
| Download URL | surpyvor-0.15.0.tar.gz |
|---|---|
| Size | 16.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
da22dcf7a03c59325d3bddc53e3e6e8c335b1758cff093257e4d3b073eb01470
|
|
BLAKE2b-256 checksum How to use checksums |
a7ed873bd93782ef72b059cee18e4e06f1e00b383883daa716475f8829182a85
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.8.10
|
Security for surpyvor 0.15.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.