http://mavis.bcgsc.ca/docs/latest/_static/acronym.svg

master branch build Status

(master)

develop branch build status

(develop)

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

Install Instructions

There are 3 major steps to setting up and installing MAVIS.

1. Install Aligner

In addition to the python package dependencies, MAVIS also requires an aligner to be installed. Currently the only aligners supported are blat and bwa mem. For MAVIS to run successfully the aligner must be installed and accessible on the path. If you have a non-standard install you may find it useful to edit the PATH environment variable. For example

export PATH=/path/to/directory/containing/blat/binary:$PATH

blat is the default aligner. To configure MAVIS to use bwa mem as a default instead, use the MAVIS environment variables. Make sure to specify BOTH of the variables below to change the default aligner.

export MAVIS_ALIGNER='bwa mem'
export MAVIS_ALIGNER_REFERENCE=/path/to/mem/fasta/ref/file

After this has been installed MAVIS itself can be installed through pip

2. Install MAVIS

Install using pip

The easiest way to install MAVIS is through the python package manager, pip. If you do not have python3 installed it can be found here

Ensuring you have a recent version of pip and setuptools will improve the install experience. Older versions of pip and setuptools may have issues with obtaining some of the mavis python dependencies

pip install --upgrade pip setuptools

or (for Anaconda users)

conda update pip setuptools

If this is not a clean/new python install it may be useful to set up mavis in a virtual python environment

Then install mavis itself

pip install mavis

This will install mavis and its python dependencies.

Install using Buildout

Alternatively you can use the bootstrap/buildout to install mavis into bin/mavis

git clone https://github.com/bcgsc/mavis.git
cd mavis
pip install zc.buildout
python bootstrap.py
bin/buildout

This will install mavis and its python dependencies into eggs inside the cloned mavis directory which can be used by simply running bin/mavis

3. Build or Download Reference Files

After MAVIS is installed the reference files must be generated (or downloaded) before it can be run. A simple bash script to download the hg19 reference files and generate a MAVIS environment file is provided under mavis/tools for convenience.

cd /path/to/where/you/want/to/put/the/files
wget https://raw.githubusercontent.com/bcgsc/mavis/master/tools/get_hg19_reference_files.sh
bash get_hg19_reference_files.sh
source reference_inputs/hg19_env.sh

Once the above 3 steps are complete MAVIS is ready to be run. See the MAVIS tutorial to learn about running MAVIS.

Citation

If you use MAVIS as a part of your project please cite

Reisle,C. et al. (2018) MAVIS: Merging, Annotation, Validation, and Illustration of Structural variants. Bioinformatics.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.1.2)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for calchoo from gravatar.com calchoo Avatar for creisle from gravatar.com creisle

Credits

Author: Caralyn Reisle

Requires

Python >=3.2

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mavis-2.1.1.tar.gz (2.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mavis-2.1.1-py3.6.egg (818.9 kB view details)

Uploaded Egg

File details

Details for the file mavis-2.1.1.tar.gz.

File metadata

  • Download URL: mavis-2.1.1.tar.gz
  • Upload date:
  • Size: 2.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mavis-2.1.1.tar.gz
Algorithm Hash digest
SHA256 06db9fb445270fe1b7a9fa3781bcac9f4cd4785cc0139d3a47709189f0ca9318
MD5 bba850cd9baa571152d51e3b0a9f8781
BLAKE2b-256 d524e7c6ff15d661670223ebfbfa62d6204afdd4ab9c9aa286bb7999de7fb841

See more details on using hashes here.

File details

Details for the file mavis-2.1.1-py3.6.egg.

File metadata

  • Download URL: mavis-2.1.1-py3.6.egg
  • Upload date:
  • Size: 818.9 kB
  • Tags: Egg
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mavis-2.1.1-py3.6.egg
Algorithm Hash digest
SHA256 39799ae27007e44378d7673a1cdf9e7cae547ca96c63d2bc54cef4559d5bcfed
MD5 62250ff662de0baebc93f0864d9ce531
BLAKE2b-256 8e475099065c6d823a2e2487bcee4859e94d062a0f3d8dfa30449428b2fe5e7d

See more details on using hashes here.

Release history Release notifications | RSS feed

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.2.12

2 files

2.2.11

3 files

2.2.9

2 files

2.2.8

2 files

2.2.7

3 files

2.2.6

3 files

2.2.5

3 files

2.2.4

3 files

2.2.3

3 files

2.2.2

3 files

2.2.1

2 files

2.2.0

2 files

2.1.7

2 files

2.1.6

2 files

2.1.4

3 files

2.1.3

2 files

2.1.2

2 files

This release

2.1.1 This release

2 files

2.1.0

2 files

2.0.0

2 files

1.8.5

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.7.1

2 files

1.7.0

2 files

1.6.10

2 files

1.6.9

2 files

1.6.8

3 files

1.6.7

2 files

1.6.6

2 files

1.6.4

2 files

1.5.4

2 files

1.5.3

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page