msaexplorer 0.4.3

A tool for exploring multiple sequence alignments.

MSAexplorer is a python package and also a standalone app to analyse multiple sequence alignments and generate publication ready figures. Want to just use the MSAexplorer app? The curently stable version of the MSAexplorer app is hosted on github pages.

[!WARNING]
You might fall in love with plotting alignments in python.

Requirements and installation

[!NOTE] MSAexplorer can be installed via PyPi. There are three different possibilities depending on whether you want to only install the python package or the python package and front end app or the python package, front end app and additional tools for aligning and trimming.

Requirements prior installation

python >= python 3.11

Basic installation (python library):

Relies on:

• matplotlib>=3.8
• numpy>=2.0

Can be installed via:

pip install msaexplorer 

Extended installation (python library + app):

Relies on:

• matplotlib>=3.8
• numpy>=2.0
• shiny>=1.3
• shinywidgets>=0.5.2
• plotly>=5.23

Can be installed via:

pip install msaexplorer[app] 

Full installation (python library + app + in-app calculations).

[!NOTE] Pyfamsa and pytrimal will require that Cmake is installed.

Relies on:

• matplotlib>=3.8
• numpy>=2.0
• shiny>=1.3
• shinywidgets>=0.5.2
• plotly>=5.23
• pyfamsa>=0.5.3
• pytrimal>=0.8.1

Can be installed via:

pip install msaexplorer[app-plus] 

Installation for development

git clone https://github.com/jonas-fuchs/MSAexplorer
cd MSAexplorer
pip install .[app-plus]

Features of MSAexplorer as an app

usage:  msaexplorer --run --port (optional) --host (optional)

The MSAexplorer app is an interactive visualization tool designed for exploring multiple sequence alignments (MSAs).

options:
  -h, --help   show this help message and exit
  --run        Start the MSAexplorer app
  --host ip    The address that the app should listen on. Defaults to 127.0.0.1
  --port port  The port that the app should listen on. Set to 0 to use a random port. Defaults to 8080.
  --version    show program's version number and exit  

• :white_check_mark: The app runs solely in your browser. No need to install anything, just might take a few seconds to load.
• :white_check_mark: Use the app offline (after loading it).
• :white_check_mark: Analyse alignments on your smartphone or tablet.
• :white_check_mark: Download alignment statistics (e.g. entropy, SNPs, coverage, consensus, ORFs and more).
• :white_check_mark: Annotate the alignment by additionally reading in gb, gff or bed files.
• :white_check_mark: Flexibility to customize plots and colors.
• :white_check_mark: Easily export the plot as pdf.
• :white_check_mark: Generate plots of the whole alignment as well as just parts of it.
• :white_check_mark: Publication ready figures with just a few clicks.

Hosting MSAexplorer yourself

If you want to host MSAexplorer e.g. for your group, you can export the app as a static html with a few easy steps. However, in-app calculations with pyfamsa and pytrimal are currently not supported.

# install shinylive for exporting
pip install shinylive
git clone https://github.com/jonas-fuchs/MSAexplorer
cd MSAexplorer
shinylive export ./ site/  # you should now have a new 'site' folder with the app

Features of MSAexplorer as a python package (full documentation)

• :white_check_mark: Access MSAexplorer as a python package
• :white_check_mark: Maximum flexibility for the plotting and analysis features while retaining minimal syntax.
• :white_check_mark: Integrates seamlessly with matplotlib.
• :white_check_mark: Minimal requirements.

### Minimal analysis example ###

from msaexplorer import explore, export

# load the alignment
aln = explore.MSA('example_alignments/DNA.fasta')
print(aln.aln_type)  # print alignment type
print(aln.length)  # print alignment length

# adjust what you want to look at
aln.reference_id = 'AB032031.1 Borna disease virus 1 genomic RNA, complete genome'  # set a reference if needed
aln.zoom = (0, 1000)  # set a zoom range

# now print for example all snps in that zoom range compared to the reference id
snps = aln.get_snps(include_ambig=True)
print(snps)
# and then save to file
export.snps(snps, path='my_path/snps.vcf', format_type='vcf')

# see documentation for full usage

### Two minimal plotting examples ###

from msaexplorer import explore, draw
import matplotlib.pyplot as plt

# Example 1
draw.identity_alignment('example_alignments/DNA.fasta')
plt.show()

# Example 2
aln = explore.MSA('example_alignments/DNA.fasta')
# adjust zoom levels (for example to also plot sequence text)
aln.zoom = (0,60)
plt.figure(figsize=(10,12))  # adjust so the sequence text fits in your figure well
draw.identity_alignment(aln, show_identity_sequence=True)
plt.show()

### Extended plotting example  ####

import matplotlib.pyplot as plt
from msaexplorer import explore
from msaexplorer import draw

#  load alignment
aln = explore.MSA("example_alignments/DNA.fasta", reference_id=None, zoom_range=None)
# set reference to first sequence
aln.reference_id = list(aln.alignment.keys())[0]

fig, ax = plt.subplots(nrows=2, height_ratios=[0.2, 2], sharex=False)

draw.stat_plot(
    aln,
    ax[0],
    stat_type="entropy",
    rolling_average=1,
    line_color="indigo"
)

draw.identity_alignment(
    aln,
    ax[1],
    show_gaps=False,
    show_mask=True,
    show_mismatches=True,
    reference_color='lightsteelblue',
    color_scheme='purine_pyrimidine',
    show_seq_names=False,
    show_ambiguities=True,
    fancy_gaps=True,
    show_x_label=False,
    show_legend=True,
    bbox_to_anchor=(1,1.05)
)

plt.show()

Exampel gallery

Citing MSAexplorer

Coming soon...