Mercurial > repos > computational-metabolomics > dimspy_process_scans

annotate README.rst @ 0:62c4813fbe7a draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
author computational-metabolomics
date Sat, 11 Apr 2020 16:48:19 -0400
parents
children deafa30d6570
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
1 Galaxy tool wrappers for DIMSpy
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
2 ========================
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
3 |Build Status (Travis)| |Git| |Bioconda| |License|
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
4
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
5 Galaxy tool wrappers for Python package DIMSpy: data processing of direct-infusion mass spectrometry (DIMS)-based metabolomics and lipidomics data
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
6
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
7 Source code: https://github.com/computational-metabolomics/dimspy
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
8
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
9 PyPI (The Python Package Index): https://pypi.org/project/dimspy
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
10
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
11
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
12 Version
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
13 --------
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
14 v1.4.0+Galaxy0 (`DIMSpy v1.4.0 <https://pypi.org/project/dimspy/1.4.0/>`_)
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
15
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
16
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
17 Galaxy
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
18 -------
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
19 `Galaxy <https://galaxyproject.org>`_ is an open, web-based platform for data intensive biomedical research. Whether on the free public server or your own instance, you can perform, reproduce, and share complete analyses.
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
20
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
21
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
22 Authors, contributors & Contacts
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
23 ----------------------------------
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
24 - Ralf J. M. Weber (r.j.weber@bham.ac.uk) - `University of Birmingham (UK) <http://www.birmingham.ac.uk/index.aspx>`_
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
25 - Thomas N. Lawson (tnl495@bham.ac.uk) - `University of Birmingham (UK) <http://www.birmingham.ac.uk/index.aspx>`_
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
26 - Martin R. Jones (m.r.jones.1@bham.ac.uk) - `University of Birmingham (UK) <http://www.birmingham.ac.uk/index.aspx>`_
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
27
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
28
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
29 Bugs
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
30 ----
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
31 Please report any bugs that you find `here <https://github.com/computational-metabolomics/dimspy-galaxy/issues>`_.
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
32 Or fork the repository on `GitHub <https://github.com/computational-metabolomics/dimspy-galaxy/>`_
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
33 and create a pull request (PR). We welcome all contributions, and we
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
34 will help you to make the PR if you are new to `git`.
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
35
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
36
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
37 Changes
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
38 -------
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
39 v1.4.0+galaxy0
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
40 - First stable release
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
41 - Final release (Python 2-based version `DIMSpy <https://pypi.org/project/dimspy/1.4.0/>`_)
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
42
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
43
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
44 Licenses
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
45 -------
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
46 DIMSpy and Galaxy tools are released under the GNU General Public License v3.0 (see `LICENSE file <https://github.com/computational-metabolomics/dimspy-galaxy/blob/master/LICENSE>`_)
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
47
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
48 **Third-party licenses and copyright**
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
49
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
50 RawFileReader reading tool. Copyright © 2016 by Thermo Fisher Scientific, Inc. All rights reserved. See `RawFileReaderLicense <https://github.com/computational-metabolomics/dimspy/blob/master/RawFileReaderLicense.rst>`_ for licensing information.
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
51 Using DIMSpy software for processing Thermo Fisher Scientific *.raw files implies the acceptance of the RawFileReader license terms.
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
52 Anyone receiving RawFileReader as part of a larger software distribution (in the current context, as part of DIMSpy) is considered an "end user" under
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
53 section 3.3 of the RawFileReader License, and is not granted rights to redistribute RawFileReader.
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
54
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
55
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
56 .. |Build Status (Travis)| image:: https://img.shields.io/travis/computational-metabolomics/dimspy-galaxy.svg?style=flat&maxAge=3600&label=Travis-CI
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
57 :target: https://travis-ci.com/computational-metabolomics/dimspy-galaxy
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
58
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
59 .. |Git| image:: https://img.shields.io/badge/repository-GitHub-blue.svg?style=flat&maxAge=3600
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
60 :target: https://github.com/computational-metabolomics/dimspy
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
61
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
62 .. |Bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat&maxAge=3600
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
63 :target: http://bioconda.github.io/recipes/dimspy/README.html
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
64
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
65 .. |License| image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg
62c4813fbe7a "planemo upload for repository https://github.com/computational-metabolomics/dimspy-galaxy commit 6321871098b2c4bc9e321d20b7e66fff3d641839"
computational-metabolomics
parents:
diff changeset
66 :target: https://www.gnu.org/licenses/gpl-3.0.html