Skip to main content

Transparent and reproducible proteomics analysis pipeline

Project description

ProteoFlux

DOI

ProteoFlux is an open-source Python framework for transparent, reproducible downstream analysis of quantitative proteomics data.

It operates on quantitative outputs generated by upstream search and quantification tools and provides a unified workflow for:

  • Protein-centric proteomics
  • Peptide-centric analyses
  • Phosphoproteomics (with optional protein-level covariate adjustment)
  • PELSA analyses

ProteoFlux emphasizes:

  • Explicit data semantics
  • Transparent preprocessing
  • Deterministic statistical modeling
  • Fully reproducible outputs

Overview

ProteoFlux overview

ProteoFlux takes a single YAML configuration file and produces:

  • Harmonized and preprocessed quantification data
  • Differential expression results using a limma-based empirical Bayes framework
  • Principal component analysis (PCA), multidimensional scaling (MDS), and hierarchical clustering
  • A structured multi-page PDF report
  • Portable .h5ad files compatible with ProteoViewer
  • Summary tables in Excel

Installation

Python ≥ 3.9 required.

Install from source (recommended)

git clone https://github.com/afanc/proteoflux.git
cd proteoflux
pip install -e .

This installs ProteoFlux in editable mode.


Quickstart (CLI)

List available configuration templates:

proteoflux templates

Create a template:

proteoflux init spectronaut-proteomics --path config.yaml

Edit the file and then run the full pipeline:

proteoflux run --config config.yaml

Output Files

File Description
*.h5ad Full AnnData object with raw, normalized, imputed data, statistics, embeddings, and metadata
*.xlsx Differential expression summary table
*.pdf Multi-page QC and analysis report

The .h5ad files are compatible with ProteoViewer, an interactive visualization tool for ProteoFlux outputs.


Using ProteoFlux as a Python Library

ProteoFlux can also be used programmatically:

import yaml
from proteoflux.main import run_pipeline

config = yaml.safe_load(open("config.yaml")) #or use a dict
run_pipeline(config)

This allows:

  • Integration into larger workflows
  • Batch processing
  • Use inside Jupyter notebooks
  • Custom downstream analysis of AnnData objects

All behavior is controlled by the same YAML schema used by the CLI.


Configuration

All parameters are defined in a single YAML configuration file. We recommend starting with a template:

proteoflux templates
proteoflux init TEMPLATE_NAME

Full parameter reference:

See the configuration guide docs/CONFIGURATION.md.


Examples

Runnable, reduced example datasets and matching configs are provided under examples/:

  • examples/searle_small/: small DIA proteomics example (Spectronaut export subset)
  • examples/phospho_small/: phosphoproteomics example with an injected flow-through covariate run (Spectronaut export subsets)
  • examples/pelsa_small/: small pelsa analysis example (Spectronaut export subsets)

Each example folder contains a README.md with a minimal command to run the pipeline (typically proteoflux run --config <config>.yaml) and the required input files (data + annotation, if applicable).


Paper

The manuscript source is provided as paper.md.


License

ProteoViewer is released under the MIT License. See the LICENSE file for details.


Citation

If you use ProteoFlux in your work, please cite:

ProteoFlux (latest version).
Zenodo. https://doi.org/10.5281/zenodo.18640998

A peer-reviewed publication is currently under submission.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

proteoflux-1.9.0.tar.gz (118.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

proteoflux-1.9.0-py3-none-any.whl (137.8 kB view details)

Uploaded Python 3

File details

Details for the file proteoflux-1.9.0.tar.gz.

File metadata

  • Download URL: proteoflux-1.9.0.tar.gz
  • Upload date:
  • Size: 118.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for proteoflux-1.9.0.tar.gz
Algorithm Hash digest
SHA256 d8fff0968d09fbc17ed025953b32c530e04e9e4763904601a969f2fbc7317f79
MD5 b2d52db51b1fe683c6586c0ca08241a3
BLAKE2b-256 d8c6b12c3750482e64b159cc0b2c055f3ce9a5889b06676578ef85f3467abc9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for proteoflux-1.9.0.tar.gz:

Publisher: release.yml on Afanc/proteoflux

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file proteoflux-1.9.0-py3-none-any.whl.

File metadata

  • Download URL: proteoflux-1.9.0-py3-none-any.whl
  • Upload date:
  • Size: 137.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for proteoflux-1.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c324cbc57765628f929fabcc07b837f6615b8bbb87583ab76a994eb6accf8b7d
MD5 500e27dd905b439bb90296a81236e788
BLAKE2b-256 3097e47c33236a9fd61ba57c900b6f9c7ce207d30031d7f5cf16ef6e532c3925

See more details on using hashes here.

Provenance

The following attestation bundles were made for proteoflux-1.9.0-py3-none-any.whl:

Publisher: release.yml on Afanc/proteoflux

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page