Skip to main content

Putative annotation of metabolites for mass spectrometry-based metabolomics datasets.

Project description

Version Py versions Git Bioconda Build Status Build Status (AppVeyor) License RTD doc codecov mybinder

BEAMSpy (Birmingham mEtabolite Annotation for Mass Spectrometry) is a Python package that includes several automated and seamless computational modules that are applied to putatively annotate metabolites detected in untargeted ultra (high) performance liquid chromatography-mass spectrometry or untargeted direct infusion mass spectrometry metabolomic assays. All reported metabolites are annotated to level 2 or 3 of the Metabolomics Standards Initiative (MSI) reporting standards (Metabolomics. 2007 Sep; 3(3): 211–221. doi: 10.1007/s11306-007-0082-2). The package is highly flexible to suit the diversity of sample types studied and mass spectrometers applied in untargeted metabolomics studies. The user can use the standard reference files included in the package or can develop their own reference files.

Quick installation

Conda

  1. Install Miniconda. Follow the steps described here.
  2. Run the following commands to install BEAMSpy.

Windows-64, Linux-64 and OSx

$ conda create -n beamspy beamspy -c conda-forge -c bioconda -c computational-metabolomics
$ activate beamspy

Linux-64 and OSx

$ conda create -n beamspy beamspy -c conda-forge -c bioconda -c computational-metabolomics
$ source activate beamspy

Usage

Command line interface (CLI)

$ beamspy --help

Graphical user interface (GUI)

$ beamspy start-gui

Bug reports

Please report any bugs that you find here. Or fork the repository on GitHub and create a pull request (PR). We welcome all contributions, and we will help you to make the PR if you are new to git.

License

Released under the GNU General Public License v3.0 (see LICENSE)

Project details


Download files

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

Files for beamspy, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size beamspy-1.1.0.tar.gz (38.1 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page