About
MAVIS is python command-line tool for the post-processing of structural variant calls. The general MAVIS pipeline consists of six main stages
Getting Help
All steps in the MAVIS pipeline are called following the main mavis entry point. The usage menu can be viewed by running without any arguments, or by giving the -h/--help option
mavis -h
Help sub-menus can be found by giving the pipeline step followed by no arguments or the -h options
mavis cluster -h
Common problems and questions are addressed on the wiki. If you have a question or issue that is not answered there (or already a github issue) please submit a github issue to our github page or contact us by email at mavis@bcgsc.ca
Getting Started
The simplest way to use MAVIS is via Singularity. The MAVIS docker container used by singularity will take care of installing the aligner as well.
pip install -U setuptools pip wheel
pip install mavis_config # also installs snakemake
Now you will run mavis via Snakemake as follows
snakemake \
-j <MAX JOBS> \
--configfile <YOUR CONFIG> \
--use-singularity \
-s Snakefile
For other installation options which do not use docker/singularity see the comprehensive install instructions in the user manual
Citation
If you use MAVIS as a part of your project please cite
Metadata
Release files for mavis 3.1.2
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 | |
|---|---|---|---|---|
| mavis-3.1.2.tar.gz | 187.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mavis-3.1.2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 401.7 kB
Release files / mavis-3.1.2.tar.gz
| Download URL | mavis-3.1.2.tar.gz |
|---|---|
| Size | 187.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c130b79a5335ef2a1f68350c636bf8094218959613a1028bd422cbdcb7ddf89c
|
|
BLAKE2b-256 checksum How to use checksums |
01b1232bf8817bf9b98c55db2f6bd0bc2160d254b58c42e499459d932bc05a49
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / mavis-3.1.2-py2.py3-none-any.whl
| Download URL | mavis-3.1.2-py2.py3-none-any.whl |
|---|---|
| Size | 214.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
576287e943c56bcdc024a186bdfa13a53d0effda5388c161db50aa38f8fbb45b
|
|
BLAKE2b-256 checksum How to use checksums |
7f786bb209e49a21a4ca555a317386452a34e0190b176f46e546414ecab2ae6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for mavis 3.1.2
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.