Metadata-Version: 2.1
Name: tidyms
Version: 0.6.3
Summary: Tools for working with MS data in metabolomics
Project-URL: Homepage, https://github.com/griquelme/tidyms
Author: Gabriel Riquelme
License: BSD 3-Clause License
        
        Copyright (c) 2020, Bioanalytical mass spectrometry group at CIBION-CONICET
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        1. Redistributions of source code must retain the above copyright notice, this
           list of conditions and the following disclaimer.
        
        2. Redistributions in binary form must reproduce the above copyright notice,
           this list of conditions and the following disclaimer in the documentation
           and/or other materials provided with the distribution.
        
        3. Neither the name of the copyright holder nor the names of its
           contributors may be used to endorse or promote products derived from
           this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.9
Requires-Dist: bokeh>=3.0
Requires-Dist: cerberus>=1.3
Requires-Dist: ipython>=8.1
Requires-Dist: joblib>=1.1
Requires-Dist: matplotlib>=3.5.1
Requires-Dist: networkx>=3.0
Requires-Dist: numpy>=1.22
Requires-Dist: openpyxl>=3.0
Requires-Dist: pandas>=1.4.1
Requires-Dist: requests
Requires-Dist: scikit-learn>=1.0.2
Requires-Dist: scipy>=1.8
Requires-Dist: seaborn>=0.11
Requires-Dist: statsmodels>=0.13
Requires-Dist: tqdm>=4.0
Requires-Dist: xlrd>=2.0
Description-Content-Type: text/markdown

TidyMS: Tools for working with MS data in metabolomics
======================================================

TidyMS is a python library for processing Mass Spectrometry data. It aims to
provide easy to use tools to read, process and visualize MS data generated in
metabolomic studies.

Features
--------

TidyMS provides functionality to:

1. Read raw MS data in the mzML format
2. Spectrum and chromatogram creation.
3. Powerful and flexible peak picking functions optimized for chromatographic
   and spectral data.
4. Feature detection and feature correspondence in LC-MS data.
5. Reading processed data in a variety of formats (XCMS, MZMine2, ...)
5. Data matrix curation using widely accepted guidelines from the metabolomics
   community.
6. Interactive visualizations of raw and processed data using Bokeh, or
   publication quality plots using seaborn.

Installation
------------

The latest release can be installed from PyPI:

```
    pip install tidyms
```

Examples
--------

Jupyter notebooks with examples are available
[here](https://github.com/griquelme/tidyms-notebooks).

Documentation
-------------

The official documentation is available at 
[readthedocs](https://tidyms.readthedocs.io/en/latest/).


Citation
--------

If you find TidyMS useful, we would appreciate citations:

Riquelme, G.; Zabalegui, N.; Marchi, P.; Jones, C.M.; Monge, M.E. A Python-Based
Pipeline for Preprocessing LC–MS Data for Untargeted Metabolomics Workflows.
_Metabolites_ **2020**, 10, 416, doi:10.3390/metabo10100416.

