masster 0.2.1__tar.gz → 0.2.2__tar.gz

{masster-0.2.1 → masster-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: masster
-Version: 0.2.1
+Version: 0.2.2
 Summary: Mass spectrometry data analysis package
 Project-URL: homepage, https://github.com/zamboni-lab/masster
 Project-URL: repository, https://github.com/zamboni-lab/masster
@@ -730,10 +730,12 @@ Description-Content-Type: text/markdown
 
 # MASSter
 
-**MASSter** is a comprehensive Python package for mass spectrometry data analysis, designed for metabolomics and LC-MS data processing. It provides tools for feature detection, alignment, consensus building, and interactive visualization of mass spectrometry datasets.
+**MASSter** is a comprehensive Python package for mass spectrometry data analysis, designed for metabolomics and LC-MS data processing. It provides tools for feature detection, alignment, consensus building, and interactive visualization of mass spectrometry datasets. It is designed to deal with DDA, and hides functionalities for DIA and ZTScan DIA data. 
 
 Most core processing functions are derived from OpenMS. We use the same nomenclature and refer to their documentation for an explanation of the parameters. To a large extent, however, you should be able to use the defaults (=no parameters) when calling processing steps.
 
+This is a poorly documented, stable branch of the development codebase in use in the Zamboni lab. Novel functionalities will be added based on need and requests.
+
 ## Features
 
 - **Mass spectrometry data processing**: Support for multiple file formats (.wiff, .mzML, .raw, .mzpkl)
@@ -751,7 +753,7 @@ pip install masster
 
 ## Quick Start
 
-### Basic Workflow
+### Basic Workflow for analyzing LC-MS study with 2-... samples
 
 ```python
 import masster
@@ -769,21 +771,33 @@ study.align(rt_max_diff=2.0)
 study.find_consensus(min_samples=3)
 
 # Retrieve missing data for quantification
-study.fill_chrom_parallel()
+study.fill_chrom(abs_)
 
 # Integrate according to consensus metadata
 study.integrate_chrom()
 
-# link MS2 across the whole study
+# link MS2 across the whole study and export them
 study.find_ms2()
-
-# Export MGF file
 study.export_mgf()
 
-# Save the study
+# Save the study to .study5
 study.save()
 ```
 
+### Study-Level Plots
+
+```python
+# Plot features from multiple samples
+study.plot_samples_2d()
+
+# Plot consensus features
+study.plot_consensus_2d()
+
+# Plot overlaid chromatograms for specific consensus features (use their uid)
+study.plot_chrom(uids=[1, 2, 3])
+```
+
+
 ### Single Sample Processing
 
 ```python
@@ -801,15 +815,13 @@ sample.find_adducts()
 # Find MS2 spectra
 sample.find_ms2()
 
-# Save results
+# Save results to .sample5
 sample.save()
 ```
 
-## Visualization Examples
-
 Masster provides extensive plotting capabilities for data exploration and quality control:
 
-### 2D Data Visualization
+### Single sample visualization
 
 ```python
 # Plot 2D overview of MS data with detected features
@@ -822,35 +834,14 @@ sample.plot_2d(
 
 # Plot with feature filtering
 sample.plot_2d(
-    filename="features_ms2_only.html",
-    show_only_features_with_ms2=True,
-    markersize=8
+    filename="features_ms2_only.html"
 )
-```
 
-### Study-Level Plots
-
-```python
-# Plot features from multiple samples
-study.plot_samples_2d(
-    samples=None,  # Use all samples
-    filename="multi_sample_overview.html",
-    markersize=3,
-    alpha_max=0.8
-)
-
-# Plot consensus features
-study.plot_consensus_2d(
-    filename="consensus_features.html",
-    colorby="number_samples",
-    sizeby="inty_mean"
-)
-
-# Plot chromatograms for specific features
-study.plot_chrom(
-    uids=[1, 2, 3],  # Feature UIDs
-    filename="chromatograms.html",
-    aligned=True
+# Plot extracted ion chromatogram
+sample.plot_eic(
+    feature_uid=123,
+    rt_tol=10,
+    mz_tol=0.005
 )
 ```
 
@@ -883,14 +874,6 @@ sample.plot_ms2_cycle(
     filename="ms2_cycle.html",
     centroid=True
 )
-
-# Plot extracted ion chromatogram
-sample.plot_eic(
-    feature_uid=123,
-    rt_tol=10,
-    mz_tol=0.005,
-    filename="eic.html"
-)
 ```
 
 ## File Format Support
@@ -919,13 +902,6 @@ python -m masster.demo.example_batch_process input_directory --recursive --dest
 
 GNU Affero General Public License v3
 
-## Contributing
-
-Contributions are welcome! Please see our contributing guidelines and code of conduct.
-
 ## Citation
 
-If you use Masster in your research, please cite:
-```
-[Citation details to be added]
-```
+If you use Masster in your research, please cite this repository.

{masster-0.2.1 → masster-0.2.2}/README.md

@@ -1,9 +1,11 @@
 # MASSter
 
-**MASSter** is a comprehensive Python package for mass spectrometry data analysis, designed for metabolomics and LC-MS data processing. It provides tools for feature detection, alignment, consensus building, and interactive visualization of mass spectrometry datasets.
+**MASSter** is a comprehensive Python package for mass spectrometry data analysis, designed for metabolomics and LC-MS data processing. It provides tools for feature detection, alignment, consensus building, and interactive visualization of mass spectrometry datasets. It is designed to deal with DDA, and hides functionalities for DIA and ZTScan DIA data. 
 
 Most core processing functions are derived from OpenMS. We use the same nomenclature and refer to their documentation for an explanation of the parameters. To a large extent, however, you should be able to use the defaults (=no parameters) when calling processing steps.
 
+This is a poorly documented, stable branch of the development codebase in use in the Zamboni lab. Novel functionalities will be added based on need and requests.
+
 ## Features
 
 - **Mass spectrometry data processing**: Support for multiple file formats (.wiff, .mzML, .raw, .mzpkl)
@@ -21,7 +23,7 @@ pip install masster
 
 ## Quick Start
 
-### Basic Workflow
+### Basic Workflow for analyzing LC-MS study with 2-... samples
 
 ```python
 import masster
@@ -39,21 +41,33 @@ study.align(rt_max_diff=2.0)
 study.find_consensus(min_samples=3)
 
 # Retrieve missing data for quantification
-study.fill_chrom_parallel()
+study.fill_chrom(abs_)
 
 # Integrate according to consensus metadata
 study.integrate_chrom()
 
-# link MS2 across the whole study
+# link MS2 across the whole study and export them
 study.find_ms2()
-
-# Export MGF file
 study.export_mgf()
 
-# Save the study
+# Save the study to .study5
 study.save()
 ```
 
+### Study-Level Plots
+
+```python
+# Plot features from multiple samples
+study.plot_samples_2d()
+
+# Plot consensus features
+study.plot_consensus_2d()
+
+# Plot overlaid chromatograms for specific consensus features (use their uid)
+study.plot_chrom(uids=[1, 2, 3])
+```
+
+
 ### Single Sample Processing
 
 ```python
@@ -71,15 +85,13 @@ sample.find_adducts()
 # Find MS2 spectra
 sample.find_ms2()
 
-# Save results
+# Save results to .sample5
 sample.save()
 ```
 
-## Visualization Examples
-
 Masster provides extensive plotting capabilities for data exploration and quality control:
 
-### 2D Data Visualization
+### Single sample visualization
 
 ```python
 # Plot 2D overview of MS data with detected features
@@ -92,35 +104,14 @@ sample.plot_2d(
 
 # Plot with feature filtering
 sample.plot_2d(
-    filename="features_ms2_only.html",
-    show_only_features_with_ms2=True,
-    markersize=8
+    filename="features_ms2_only.html"
 )
-```
 
-### Study-Level Plots
-
-```python
-# Plot features from multiple samples
-study.plot_samples_2d(
-    samples=None,  # Use all samples
-    filename="multi_sample_overview.html",
-    markersize=3,
-    alpha_max=0.8
-)
-
-# Plot consensus features
-study.plot_consensus_2d(
-    filename="consensus_features.html",
-    colorby="number_samples",
-    sizeby="inty_mean"
-)
-
-# Plot chromatograms for specific features
-study.plot_chrom(
-    uids=[1, 2, 3],  # Feature UIDs
-    filename="chromatograms.html",
-    aligned=True
+# Plot extracted ion chromatogram
+sample.plot_eic(
+    feature_uid=123,
+    rt_tol=10,
+    mz_tol=0.005
 )
 ```
 
@@ -153,14 +144,6 @@ sample.plot_ms2_cycle(
     filename="ms2_cycle.html",
     centroid=True
 )
-
-# Plot extracted ion chromatogram
-sample.plot_eic(
-    feature_uid=123,
-    rt_tol=10,
-    mz_tol=0.005,
-    filename="eic.html"
-)
 ```
 
 ## File Format Support
@@ -189,13 +172,6 @@ python -m masster.demo.example_batch_process input_directory --recursive --dest
 
 GNU Affero General Public License v3
 
-## Contributing
-
-Contributions are welcome! Please see our contributing guidelines and code of conduct.
-
 ## Citation
 
-If you use Masster in your research, please cite:
-```
-[Citation details to be added]
-```
+If you use Masster in your research, please cite this repository.

{masster-0.2.1 → masster-0.2.2}/pyproject.toml

@@ -1,7 +1,7 @@
 
 [project]
 name = "masster"
-version = "0.2.1"
+version = "0.2.2"
 description = "Mass spectrometry data analysis package"
 authors = [
     { name = "Zamboni Lab" }

{masster-0.2.1 → masster-0.2.2}/src/masster/_version.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 
-__version__ = "0.2.1"
+__version__ = "0.2.2"
 
 
 def get_version():