Metadata-Version: 2.1
Name: picked-group-fdr
Version: 0.6.3
Summary: Scalable, accurate and sensitive protein group FDRs for large-scale mass spectrometry experiments
Home-page: https://github.com/kusterlab/picked_group_fdr
License: Apache-2.0
Keywords: mass spectrometry,protein inference,proteomics
Author: Matthew The
Author-email: matthew.the@tum.de
Requires-Python: >=3.8,<3.12
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: gui
Requires-Dist: Bottleneck (>=1.3.5,<2.0.0)
Requires-Dist: cython (>=0.29.21)
Requires-Dist: job-pool (>=0.2.6,<0.3.0)
Requires-Dist: llvmlite (>=0.39.1,<0.40.0)
Requires-Dist: matplotlib (>=3.3.1,<4.0.0)
Requires-Dist: mokapot (>=0.3)
Requires-Dist: networkx (>=2.4,<3.0)
Requires-Dist: numpy (>=1.18,<2.0)
Requires-Dist: pyqt5 (>=5.15.7,<6.0.0) ; extra == "gui"
Requires-Dist: scipy (>=1.9,<2.0)
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: triqler (>=0.4.0)
Project-URL: Repository, https://github.com/kusterlab/picked_group_fdr
Description-Content-Type: text/markdown

# Picked Protein Group FDR

[![PyPI version](https://img.shields.io/pypi/v/picked_group_fdr.svg?logo=pypi&logoColor=FFE873)](https://pypi.org/project/picked_group_fdr/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/picked_group_fdr.svg?logo=python&logoColor=FFE873)](https://pypi.org/project/picked_group_fdr/)
[![PyPI downloads](https://img.shields.io/pypi/dm/picked_group_fdr.svg)](https://pypistats.org/packages/picked_group_fdr)

Scalable, accurate and sensitive protein group FDRs for large-scale mass spectrometry experiments.

Different search engine outputs are supported:
- [MaxQuant](https://www.maxquant.org/) (LFQ, TMT, SILAC)
- [Percolator](https://github.com/percolator/percolator) (no quantification)
- [FragPipe](https://fragpipe.nesvilab.org/) (LFQ)
- [Sage](https://github.com/lazear/sage) (LFQ)

Examples on how to run Picked Protein Group FDR with these different search engine outputs can be found in the `data/` folder.

## Running Picked Protein Group FDR using the GUI

On Windows, you can download the `PickedGroupFDR_GUI_windows.zip` from the [latest release](https://github.com/kusterlab/picked_group_fdr/releases), unzip it and open `PickedGroupFDR.exe` to start the GUI (no installation necessary).

Make sure that you have run your database search with 100% protein-level FDR.

Alternatively, on all platforms, first install Picked Protein Group FDR as explained below. Then install `PyQt5` (`pip install PyQt5`) and run:

```shell
python gui.py
```

## Running Picked Protein Group FDR from the command line (MaxQuant results)

1. install Picked Protein Group FDR as explained below.
2. make sure that you have run the MaxQuant search with 100% protein-level FDR.
3. the posterior error probabilities (PEP) of MaxQuant are not well-calibrated. Therefore, we first recalculate these with [Mokapot](https://mokapot.readthedocs.io/en/latest/) (=[Percolator](http://percolator.ms/) for Python):
   ```shell
   python3 -u -m picked_group_fdr.pipeline.andromeda2pin </path/to/mq_evidence_txt> --outputTab andromeda.tab --databases </path/to/fasta_file>
   python3 -u -m picked_group_fdr.pipeline.run_mokapot 0.01 0.01 percolator <num_threads>
   python3 -u -m picked_group_fdr.pipeline.update_evidence_from_pout --mq_evidence </path/to/mq_evidence_txt> --perc_results percolator/andromeda.mokapot.psms.txt percolator/andromeda.mokapot.decoys.psms.txt --mq_evidence_out percolator/evidence.txt
   ```
    Alternatively, you can use [Prosit](https://www.proteomicsdb.org/prosit/)'s Percolator results files directly:
   ```shell
   python3 -u -m picked_group_fdr.pipeline.update_evidence_from_pout --mq_evidence </path/to/mq_evidence_txt> --perc_results prosit_target.psms prosit_decoy.psms --mq_evidence_out percolator/evidence.txt --pout_input_type prosit
   ```
4. to obtain protein group level FDRs, run:
   ```shell
   python -m picked_group_fdr --mq_evidence percolator/evidence.txt --fasta </path/to/fasta_file>
   ```


## Installation

Picked Protein Group FDR is available on PyPI and can be installed with `pip`:

```shell
pip install picked_group_fdr
```

Alternatively, you can install directly from this repository:

```shell
git clone https://github.com/kusterlab/picked_group_fdr.git
pip install .
```


## Manuscript figures

To reproduce the figures from the manuscript:

1. make sure that you have `make` installed.
2. download the input files from zenodo: https://zenodo.org/record/7157677
3. specify the location of the input files and run the make command with the figure you want to reproduce, e.g.:
   ```shell
   export DATA_DIR=</path/to/zenodo/files>
   make Figure3a
   ```

Check the file `MakefileFigures` to see which figures are available.

