Skip to content

Commit d87c1d5

Browse files
RJMWRJMW
authored
Release v1.1.0 (#13)
* Refactor functions * Update databases (HMDB, LIPID MAPS, etc) * Include subgroups to improve annotations (adducts, isotopes, etc) * Improve summary outputs * Update and Improve GUI * Fix FutureWarnings * Add GitHub actions (#9) * Update dependencies (#12) * Update tests * Update examples * Update README
1 parent c745cc6 commit d87c1d5

File tree

92 files changed

+4080
-2989
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+4080
-2989
lines changed

‎.coveragerc‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[run]
2+
omit = tests/*,setup.py,beamspy/__main__.py,beamspy/qt/form.py,beamspy/gui.py

‎.github/workflows/build-test.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: beamspy
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ${{ matrix.os }}
8+
9+
strategy:
10+
matrix:
11+
os: [ubuntu-latest, windows-latest, macos-latest]
12+
python-version: [3.7, 3.8]
13+
14+
env:
15+
OS: ${{ matrix.os }}
16+
PYTHON: ${{ matrix.python-version }}
17+
18+
steps:
19+
- uses: actions/checkout@v2
20+
21+
- name: Setup conda - Python ${{ matrix.python-version }}
22+
uses: s-weigand/setup-conda@v1
23+
with:
24+
update-conda: true
25+
python-version: ${{ matrix.python-version }}
26+
conda-channels: conda-forge, bioconda
27+
28+
- name: Install dependencies
29+
run: |
30+
31+
python --version
32+
conda env update --file environment.yml --name base
33+
34+
- name: Lint with flake8
35+
run: |
36+
37+
conda install flake8
38+
39+
# stop build if there are Python syntax errors or undefined names
40+
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
41+
42+
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
43+
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
44+
45+
- name: Test with pytest-cov
46+
run: |
47+
48+
python setup.py install
49+
beamspy --help
50+
51+
conda install pytest codecov pytest-cov -c conda-forge
52+
pytest --cov ./ --cov-config=.coveragerc --cov-report=xml
53+
54+
- name: Upload code coverage to codecov
55+
uses: codecov/codecov-action@v1
56+
with:
57+
flags: unittests
58+
env_vars: OS,PYTHON
59+
fail_ci_if_error: true
60+
verbose: true

‎.travis.yml‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,22 @@ python:
66
services:
77
- xvfb
88

9+
before_install:
10+
- python --version
11+
- pip install -U pip
12+
- pip install -U pytest
13+
- pip install codecov pytest-cov
14+
915
install:
10-
- pip install coverage
11-
- pip install green codecov
1216
- pip install .
1317

1418
before_script:
1519
- "export DISPLAY=:99.0"
1620

1721
script:
1822
- beamspy --help
19-
- green -vvv --run-coverage
23+
- pytest --cov=beamspy tests/
2024

2125
after_script:
22-
- python -m codecov
26+
- codecov
27+

‎MANIFEST.in‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
include README.rst
22
include LICENSE
3-
include requirements*.txt
4-
include examples/*.*
3+
include requirements.txt
4+
include examples/run.py
5+
include examples/run.sh
56
include tests/*.py
67
include tests/test_data/*.*
78
include tests/test_results/.gitignore

‎README.rst‎

Lines changed: 113 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,113 @@
1-
BEAMSpy - Birmingham mEtabolite Annotation for Mass Spectrometry (Python package)
2-
==================================================================================
3-
|Version| |Py versions| |Git| |Bioconda| |Build Status (Travis)| |Build Status (AppVeyor)| |License| |RTD doc| |codecov| |mybinder|
4-
5-
BEAMSpy (Birmingham mEtabolite Annotation for Mass Spectrometry) is a Python package that includes several automated and
6-
seamless computational modules that are applied to putatively annotate metabolites detected in untargeted ultra (high)
7-
performance liquid chromatography-mass spectrometry or untargeted direct infusion mass spectrometry metabolomic assays
8-
in an automated process. All reported metabolites are annotated to level 3 of the Metabolomics Standards
9-
Initiative (MSI) reporting standards (Metabolomics. 2007 Sep; 3(3): 211–221. `doi: 10.1007/s11306-007-0082-2 <https://doi.org/10.1007/s11306-007-0082-2>`_).
10-
11-
The package is highly flexible to suit the diversity of sample types studied and mass spectrometers applied in
12-
untargeted metabolomics studies. The user can use the standard reference files included in the package or can develop
13-
their own reference files.
14-
15-
16-
- `Documentation (Read the Docs) <https://beamspy.readthedocs.io/en/latest/>`_
17-
- `Bug reports <https://github.com/computational-metabolomics/beamspy/issues>`_
18-
19-
20-
.. _quick_installation:
21-
22-
Quick installation
23-
-------------------
24-
25-
Conda_
26-
~~~~~~~
27-
28-
1. `Install Miniconda <https://conda.io/docs/user-guide/install>`_.
29-
2. Run the following commands to install BEAMSpy.
30-
31-
Windows-64, Linux-64 and OSx
32-
33-
::
34-
35-
$ conda create -n beamspy beamspy -c conda-forge -c bioconda -c computational-metabolomics
36-
$ activate beamspy
37-
38-
Linux-64 and OSx
39-
40-
::
41-
42-
$ conda create -n beamspy beamspy -c conda-forge -c bioconda -c computational-metabolomics
43-
$ source activate beamspy
44-
45-
46-
Usage
47-
------------------------
48-
49-
Command line interface (CLI)
50-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51-
52-
::
53-
54-
$ beamspy --help
55-
56-
Graphical user interface (GUI)
57-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58-
59-
::
60-
61-
$ beamspy start-gui
62-
63-
Bug reports
64-
------------------------
65-
66-
Please report any bugs that you find `here <https://github.com/computational-metabolomics/beamspy/issues>`_.
67-
Or fork the repository on `GitHub <https://github.com/computational-metabolomics/beamspy/>`_
68-
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 <https://guides.github.com/activities/hello-world/>`_.
69-
70-
License
71-
------------------------
72-
73-
Released under the GNU General Public License v3.0 (see `LICENSE file <https://github.com/computational-metabolomics/beamspy/LICENSE>`_)
74-
75-
.. |Build Status (Travis)| image:: https://img.shields.io/travis/computational-metabolomics/beamspy.svg?branch=dev&style=flat&maxAge=3600&label=Travis-CI
76-
:target: https://travis-ci.com/computational-metabolomics/beamspy
77-
78-
.. |Build Status (AppVeyor)| image:: https://img.shields.io/appveyor/ci/RJMW/beamspy.svg?style=flat&maxAge=3600&label=AppVeyor
79-
:target: https://ci.appveyor.com/project/RJMW/beamspy
80-
81-
.. |Py versions| image:: https://img.shields.io/pypi/pyversions/beamspy.svg?style=flat&maxAge=3600
82-
:target: https://pypi.python.org/pypi/beamspy/
83-
84-
.. |Version| image:: https://img.shields.io/pypi/v/beamspy.svg?style=flat&maxAge=3600
85-
:target: https://pypi.python.org/pypi/beamspy/
86-
87-
.. |Git| image:: https://img.shields.io/badge/repository-GitHub-blue.svg?style=flat&maxAge=3600
88-
:target: https://github.com/computational-metabolomics/beamspy
89-
90-
.. |Bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat&maxAge=3600
91-
:target: http://bioconda.github.io/recipes/beamspy/README.html
92-
93-
.. |License| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
94-
:target: https://www.gnu.org/licenses/gpl-3.0.html
95-
96-
.. |RTD doc| image:: https://img.shields.io/badge/documentation-RTD-71B360.svg?style=flat&maxAge=3600
97-
:target: https://beamspy.readthedocs.io/en/latest/
98-
99-
.. |codecov| image:: https://codecov.io/gh/computational-metabolomics/beamspy/branch/master/graph/badge.svg
100-
:target: https://codecov.io/gh/computational-metabolomics/beamspy
101-
102-
.. |mybinder| image:: https://mybinder.org/badge_logo.svg
103-
:target: https://mybinder.org/v2/gh/computational-metabolomics/beamspy/master?filepath=notebooks
104-
105-
.. _pip: https://pip.pypa.io/
106-
.. _Conda: http://conda.pydata.org/docs/
1+
BEAMSpy - Birmingham mEtabolite Annotation for Mass Spectrometry (Python package)
2+
==================================================================================
3+
|Version| |Py versions| |Git| |Bioconda| |Build Status| |Build Status (AppVeyor)| |License| |RTD doc| |codecov| |mybinder|
4+
5+
BEAMSpy (Birmingham mEtabolite Annotation for Mass Spectrometry) is a Python package that includes several automated and
6+
seamless computational modules that are applied to putatively annotate metabolites detected in untargeted ultra (high)
7+
performance liquid chromatography-mass spectrometry or untargeted direct infusion mass spectrometry metabolomic assays.
8+
All reported metabolites are annotated to level 2 or 3 of the Metabolomics Standards
9+
Initiative (MSI) reporting standards (Metabolomics. 2007 Sep; 3(3): 211–221. `doi: 10.1007/s11306-007-0082-2 <https://doi.org/10.1007/s11306-007-0082-2>`_).
10+
The package is highly flexible to suit the diversity of sample types studied and mass spectrometers applied in
11+
untargeted metabolomics studies. The user can use the standard reference files included in the package or can develop
12+
their own reference files.
13+
14+
15+
- `Documentation (Read the Docs) <https://beamspy.readthedocs.io/en/latest/>`_
16+
- `Bug reports <https://github.com/computational-metabolomics/beamspy/issues>`_
17+
18+
19+
Quick installation
20+
-------------------
21+
22+
Conda_
23+
~~~~~~~
24+
25+
1. Install `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_. Follow the steps described `here <https://docs.conda.io/projects/conda/en/latest/user-guide/install>`__.
26+
2. Run the following commands to install BEAMSpy.
27+
28+
Windows-64, Linux-64 and OSx
29+
30+
::
31+
32+
$ conda create -n beamspy beamspy -c conda-forge -c bioconda -c computational-metabolomics
33+
$ activate beamspy
34+
35+
Linux-64 and OSx
36+
37+
::
38+
39+
$ conda create -n beamspy beamspy -c conda-forge -c bioconda -c computational-metabolomics
40+
$ source activate beamspy
41+
42+
43+
Usage
44+
------------------------
45+
46+
Command line interface (CLI)
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
::
50+
51+
$ beamspy --help
52+
53+
Graphical user interface (GUI)
54+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55+
56+
::
57+
58+
$ beamspy start-gui
59+
60+
61+
Bug reports
62+
------------------------
63+
64+
Please report any bugs that you find `here <https://github.com/computational-metabolomics/beamspy/issues>`__.
65+
Or fork the repository on `GitHub <https://github.com/computational-metabolomics/beamspy/>`_
66+
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 <https://guides.github.com/activities/hello-world/>`_.
67+
68+
69+
Credits
70+
-------
71+
- `Team (University of Birmingham and EMBL-EBI) <https://more.bham.ac.uk/beams/team/>`__
72+
73+
**Code base**
74+
- Ralf J. M. Weber ([email protected]) - `University of Birmingham (UK) <https://www.birmingham.ac.uk/staff/profiles/biosciences/weber-ralf.aspx>`__
75+
76+
77+
License
78+
------------------------
79+
80+
Released under the GNU General Public License v3.0 (see `LICENSE <https://github.com/computational-metabolomics/beamspy/blob/master/LICENSE>`_)
81+
82+
.. |Build Status| image:: https://github.com/computational-metabolomics/beamspy/workflows/beamspy/badge.svg
83+
:target: https://github.com/computational-metabolomics/beamspy/actions
84+
85+
.. |Build Status (AppVeyor)| image:: https://img.shields.io/appveyor/ci/RJMW/beamspy.svg?style=flat&maxAge=3600&label=AppVeyor
86+
:target: https://ci.appveyor.com/project/RJMW/beamspy
87+
88+
.. |Py versions| image:: https://img.shields.io/pypi/pyversions/beamspy.svg?style=flat&maxAge=3600
89+
:target: https://pypi.python.org/pypi/beamspy/
90+
91+
.. |Version| image:: https://img.shields.io/pypi/v/beamspy.svg?style=flat&maxAge=3600
92+
:target: https://pypi.python.org/pypi/beamspy/
93+
94+
.. |Git| image:: https://img.shields.io/badge/repository-GitHub-blue.svg?style=flat&maxAge=3600
95+
:target: https://github.com/computational-metabolomics/beamspy
96+
97+
.. |Bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat&maxAge=3600
98+
:target: http://bioconda.github.io/recipes/beamspy/README.html
99+
100+
.. |License| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
101+
:target: https://www.gnu.org/licenses/gpl-3.0.html
102+
103+
.. |RTD doc| image:: https://img.shields.io/badge/documentation-RTD-71B360.svg?style=flat&maxAge=3600
104+
:target: https://beamspy.readthedocs.io/en/latest/
105+
106+
.. |codecov| image:: https://codecov.io/gh/computational-metabolomics/beamspy/branch/master/graph/badge.svg
107+
:target: https://codecov.io/gh/computational-metabolomics/beamspy
108+
109+
.. |mybinder| image:: https://mybinder.org/badge_logo.svg
110+
:target: https://mybinder.org/v2/gh/computational-metabolomics/beamspy/master?filepath=notebooks
111+
112+
.. _pip: https://pip.pypa.io/
113+
.. _Conda: https://conda.io/en/latest/

‎appveyor.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build_script:
66
- '%PYTHON%\python.exe -m pip install .'
77

88
before_test:
9-
- '%PYTHON%\python.exe -m pip install coverage green'
9+
- '%PYTHON%\python.exe -m pip install pytest'
1010

1111
test_script:
12-
- '%PYTHON%\python.exe -m green -vvv --run-coverage'
12+
- '%PYTHON%\python.exe -m pytest'

‎beamspy/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
__author__ = '[email protected]'
22
__credits__ = '[email protected]'
3-
__version__ = '1.0.0'
3+
__version__ = '1.1.0'
44
__license__ = 'GPLv3'

0 commit comments

Comments
 (0)