|
1 | 1 | # API Reference |
2 | 2 |
|
3 | | -Browse the main public APIs exposed by `metbit`. The preferred import style is: |
| 3 | +Browse the public API exposed by `metbit` (sorted by category). |
4 | 4 |
|
5 | | -```python |
6 | | -from metbit import pca, opls_da, nmr_preprocessing, Normalization |
7 | | -``` |
| 5 | +## Data Processing |
8 | 6 |
|
9 | | -Advanced users can also import from subpackages such as `metbit.analysis`, `metbit.nmr`, `metbit.preprocessing`, `metbit.stats`, and `metbit.apps`. |
10 | | - |
11 | | -## NMR Data Processing |
12 | | - |
13 | | -- [nmr_preprocessing](/docs/api/nmr_preprocess) - read Bruker FID folders and generate processed spectra. |
14 | | -- [calibrate](/docs/api/calibrate) - calibrate chemical-shift axes. |
15 | | -- [baseline_correct and bline](/docs/api/baseline) - baseline correction helpers. |
16 | | -- [detect_multiplets, icoshift_align, and PeakAligner](/docs/api/peak_processe) - peak detection and interval alignment utilities. |
17 | | -- [peak_chops](/docs/api/peak_processe) - peak-region extraction. |
18 | | -- [denoise_spec](/docs/api/denoise_spec) - spectral denoising helpers. |
19 | | - |
20 | | -## Normalization and Pretreatment |
21 | | - |
22 | | -- [Normalization](/docs/api/spec_norm) - static PQN, SNV, MSC, and combined normalization methods. |
23 | | -- [Normalise](/docs/api/utility) - class-based normalization utilities. |
24 | | -- [scaler](/docs/api/scaler) - scaling utilities used by statistical models. |
25 | | -- [pretreatment](/docs/api/pretreatment) - preprocessing and transformation helpers. |
| 7 | +- [calibrate](/docs/api/metbit.nmr.calibrate) |
| 8 | +- [nmr_preprocessing](/docs/api/metbit.nmr.preprocess) |
| 9 | +- [Normalise](/docs/api/metbit.stats.normalise) |
| 10 | +- [Normalization](/docs/api/metbit.preprocessing.normalize) |
| 11 | +- [peak_chops](/docs/api/metbit.nmr.peaks) |
26 | 12 |
|
27 | 13 | ## Statistical Models |
28 | 14 |
|
29 | | -- [pca](/docs/api/metbit) - PCA model with interactive scores, loading, variance, and trajectory plots. |
30 | | -- [opls_da](/docs/api/metbit) - OPLS-DA model with cross-validation, permutation testing, VIP, loading, S-plot, and scores plotting. |
31 | | -- [lazy_opls_da](/docs/api/lazy_opls_da) - convenience workflow for OPLS-DA analysis. |
32 | | -- [OPLS](/docs/api/opls) - lower-level OPLS model implementation. |
33 | | -- [PLS](/docs/api/pls) - lower-level PLS model implementation. |
34 | | -- [CrossValidation](/docs/api/cross_validation) - cross-validation helpers. |
35 | | -- [VIP helpers](/docs/api/vip) - Variable Importance in Projection utilities. |
36 | | -- [UnivarStats](/docs/api/utility) - univariate statistical analysis helpers. |
37 | | - |
38 | | -## Visualization and Interactive Apps |
39 | | - |
40 | | -- [STOCSY](/docs/api/STOCSY) - Statistical Total Correlation Spectroscopy. |
41 | | -- [STOCSY_app](/docs/api/ui_stocsy) - interactive Dash STOCSY app. |
42 | | -- [pickie_peak](/docs/api/ui_picky_peak) - interactive peak-picking app. |
43 | | -- [annotate_peak](/docs/api/annotate_peak) - peak annotation helper. |
44 | | -- [get_intensity](/docs/api/take_intensity) - peak intensity extraction. |
45 | | -- [plotting](/docs/api/plotting) - reusable plotting helpers. |
46 | | -- [boxplot](/docs/api/boxplot) - boxplot visualization utilities. |
47 | | -- [pca_ellipse](/docs/api/pca_ellipse) - confidence ellipse plotting. |
| 15 | +- [opls_da](/docs/api/metbit.analysis.opls_da) |
| 16 | +- [pca](/docs/api/metbit.analysis.pca) |
| 17 | +- [UnivarStats](/docs/api/metbit.stats.univariate) |
| 18 | + |
| 19 | +## Data Visualization |
| 20 | + |
| 21 | +- [STOCSY](/docs/api/metbit.analysis.stocsy) |
| 22 | + |
| 23 | +## Other |
| 24 | + |
| 25 | +- [ANOVAStats](/docs/api/metbit.stats.multitest) |
| 26 | +- [available_cv_strategies](/docs/api/metbit.validation.splitter) |
| 27 | +- [backend_info](/docs/api/metbit._native) |
| 28 | +- [baseline_correct](/docs/api/metbit.preprocessing.baseline) |
| 29 | +- [Biplot](/docs/api/metbit.viz.interpretation) |
| 30 | +- [bline](/docs/api/metbit.preprocessing.baseline) |
| 31 | +- [ChunkedSTOCSY](/docs/api/metbit.analysis.large_scale) |
| 32 | +- [CoefficientPlot](/docs/api/metbit.viz.interpretation) |
| 33 | +- [CorrelationMatrix](/docs/api/metbit.viz.summary) |
| 34 | +- [CrossValidator](/docs/api/metbit.validation.splitter) |
| 35 | +- [detect_multiplets](/docs/api/metbit.nmr.alignment) |
| 36 | +- [feature_preselection](/docs/api/metbit.analysis.large_scale) |
| 37 | +- [FeatureHeatmap](/docs/api/metbit.viz.summary) |
| 38 | +- [FeatureImportancePlot](/docs/api/metbit.viz.interpretation) |
| 39 | +- [FoldChangePlot](/docs/api/metbit.viz.profiling) |
| 40 | +- [gpu_available](/docs/api/metbit._native) |
| 41 | +- [GroupComparison](/docs/api/metbit.viz.profiling) |
| 42 | +- [hca](/docs/api/metbit.analysis.multivariate) |
| 43 | +- [ica](/docs/api/metbit.analysis.multivariate) |
| 44 | +- [icoshift_align](/docs/api/metbit.nmr.alignment) |
| 45 | +- [KruskalStats](/docs/api/metbit.stats.multitest) |
| 46 | +- [LargeScaleAlignment](/docs/api/metbit.analysis.large_scale) |
| 47 | +- [lda](/docs/api/metbit.analysis.multivariate) |
| 48 | +- [memory_report](/docs/api/metbit.analysis.large_scale) |
| 49 | +- [MemoryEstimator](/docs/api/metbit.analysis.large_scale) |
| 50 | +- [ModelValidator](/docs/api/metbit.validation.metrics) |
| 51 | +- [native_available](/docs/api/metbit._native) |
| 52 | +- [PeakAligner](/docs/api/metbit.nmr.alignment) |
| 53 | +- [plsr](/docs/api/metbit.analysis.multivariate) |
| 54 | +- [PValueTable](/docs/api/metbit.viz.summary) |
| 55 | +- [SpectraPlot](/docs/api/metbit.viz.spectra) |
| 56 | +- [TrainTestSplit](/docs/api/metbit.validation.splitter) |
| 57 | +- [VolcanoPlot](/docs/api/metbit.stats.multitest) |
| 58 | + |
0 commit comments