Skip to content

Commit 0662288

Browse files
committed
Update README according to develop branch's.
1 parent 47d0b6e commit 0662288

File tree

1 file changed

+32
-38
lines changed

1 file changed

+32
-38
lines changed

README.md

Lines changed: 32 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<img src="https://raw.githubusercontent.com/Nesvilab/FragPipe/develop/images/fragpipe-01.png" width="350px"/>
55
</div>
66

7-
FragPipe is a comprehensive computational platform for analyzing mass spectrometry-based proteomics data. FragPipe comes with an easy to use Java Graphical User Interface (GUI) but can also be run in the command line mode, on Windows, Linux, or in the cloud environment. It is powered by [MSFragger](https://msfragger.nesvilab.org/) - an ultrafast proteomic search engine suitable for both conventional and "open" (wide precursor mass tolerance) peptide identification. FragPipe includes Percolator and the [Philosopher](https://nesvilab.github.io/philosopher/) toolkit for downstream post-processing of MSFragger search results (PeptideProphet, iProphet, ProteinProphet), FDR filtering, label-based quantification, and multi-experiment summary report generation. FragPipe includes MSBooster module for deep-learning based rescoring of peptide identifications. [Crystal-C](https://www.nesvilab.org/Crystal-C/) and [PTM-Shepherd](https://github.com/Nesvilab/PTM-Shepherd) are included to aid interpretation of open search results. Also included in FragPipe binary are [TMT-Integrator](http://tmt-integrator.nesvilab.org/) for TMT/iTRAQ isobaric labeling-based quantification, [IonQuant](http://ionquant.nesvilab.org/) for label-free quantification with FDR-controlled match-between-run (MBR) functionality, spectral library building with EasyPQP, and MSFragger-DIA, DIA-Umpire SE, and diaTracer modules for direct ("library-free") analysis of data independent acquisition (DIA) data. FragPipe includes DIA-NN for extraction of quantification from DIA data.
7+
FragPipe is a comprehensive computational platform designed for the analysis of mass spectrometry-based proteomics data. It includes a Graphical User Interface and pipeline wrapper code (FragPipe-GUI), distributed alongside various independent software tools and workflow files. FragPipe can be run using GUI or in the command line mode, on Windows, Linux, or in the cloud environment. It is powered by [MSFragger](https://msfragger.nesvilab.org/) - an ultrafast proteomic search engine suitable for both conventional and "open" (wide precursor mass tolerance) peptide identification. FragPipe includes Percolator and the [Philosopher](https://nesvilab.github.io/philosopher/) toolkit for downstream post-processing of MSFragger search results (PeptideProphet, iProphet, ProteinProphet), FDR filtering, and multi-experiment summary report generation. FragPipe includes MSBooster module for deep-learning based rescoring of peptide identifications. [Crystal-C](https://www.nesvilab.org/Crystal-C/) and [PTM-Shepherd](https://github.com/Nesvilab/PTM-Shepherd) are included to aid interpretation of results from "open" and "mass offset" searches for post-translational modifications (PTM). FragPipe supports all modes of quantification, including MS1-based isotope labeling (e.g. SILAC) or MS1-based label-free quantification with FDR-controlled match-between-run (LFQ-MBR) using IonQuant [IonQuant](http://ionquant.nesvilab.org/), TMT/iTRAQ isobaric labeling-based quantification using IonQuant and [TMT-Integrator](http://tmt-integrator.nesvilab.org/). FragPipe provides a comprehensive list of workflows for the analysis of data independent acquisition (DIA) data with MSFragger-DIA, DIA-Umpire/MSFragger, and diaTracer/MSFragger workflows for direct ("library-free") peptide identification from DIA files, spectral library building with EasyPQP, and extraction of quantification using DIA-NN and Skyline.
88

99

1010
### [Download](https://github.com/Nesvilab/FragPipe/releases)
@@ -71,36 +71,34 @@ _Bruker .d indicates ddaPASEF files from timsTOF, other Bruker .d files should b
7171
_DIA data acquired with overlapping/staggered windows must be [converted to mzML with demultiplexing](https://fragpipe.nesvilab.org/docs/tutorial_convert.html#convert-thermo-dia-raw-files-with-overlappingstaggered-windows)._
7272
_Quantification from Thermo .raw files with DIA-NN requires installation of Thermo MS File Reader, see the [DIA-NN documentation](https://github.com/vdemichev/DiaNN#raw-data-formats) for details._
7373

74-
Please note TMT/iTRAQ quantification from Thermo .raw files will take longer than from .mzML files.
75-
76-
7774

7875
#### Additional Documentation
79-
Complete MSFragger documentation can be found on the [MSFragger wiki](https://github.com/Nesvilab/MSFragger/wiki).
80-
For documentation on the Philosopher toolkit see the [Philosopher wiki](https://github.com/Nesvilab/philosopher/wiki).
76+
- [DIA-Umpire](https://diaumpire.nesvilab.org/)
77+
- [diaTracer](https://diatracer.nesvilab.org/)
78+
- [MSFragger wiki](https://github.com/Nesvilab/MSFragger/wiki)
79+
- [Crystal-C](https://www.nesvilab.org/Crystal-C/)
80+
- [MSBooster](https://github.com/Nesvilab/MSBooster)
81+
- [Philosopher wiki](https://github.com/Nesvilab/philosopher/wiki)
82+
- [PTM-Shepherd](https://ptmshepherd.nesvilab.org/)
83+
- [IonQuant](http://ionquant.nesvilab.org/)
84+
- [TMT-Integrator](http://tmt-integrator.nesvilab.org/)
8185

8286
#### Questions and Technical Support
8387
View previous questions/bug reports in the
84-
[FragPipe issue tracker](https://github.com/Nesvilab/FragPipe/issues). Please post any new questions/bug reports regarding FragPipe itself here as well.
85-
For questions specific to individual components of FragPipe you can also
86-
use [MSFragger issue tracker](https://github.com/Nesvilab/MSFragger/issues),
87-
[Philosopher issue tracker](https://github.com/Nesvilab/philosopher/issues),
88-
[IonQuant issue tracker](https://github.com/Nesvilab/IonQuant/issues).
89-
See the MSFragger [wiki](https://github.com/Nesvilab/MSFragger/wiki) and [FAQ](https://github.com/Nesvilab/MSFragger/wiki/Frequently-Asked-Questions).
90-
88+
[FragPipe issue tracker](https://github.com/Nesvilab/FragPipe/issues).
9189

9290
For other tools developed by Nesvizhskii lab, visit our website
9391
[nesvilab.org](http://www.nesvilab.org)
9492

9593
#### How to Run
9694
- **Windows**:
97-
- Double click the `FragPipe.exe` or `FragPipe.bat` from the `bin` folder
98-
- Or execute the command: `java -jar FragPipe-x.x.jar`
95+
- Install FragPipe by double-clicking the `FragPipe-x.x-Installer.exe`
96+
- Double click the `FragPipe-x.x.exe` at the Desktop
9997
- **Linux**:
10098
- Run the `fragpipe` shell script (can double-click to run)
101-
- Or execute the command: `java -jar FragPipe-x.x.jar`
10299
- **Mac OS** (command line interface only):
103100
- Read [Pulling and running FragPipe using Docker](https://fragpipe.nesvilab.org/docs/tutorial_docker.html)
101+
104102

105103
#### Integration
106104
FragPipe is open source and the output is currently supported by the following software projects:
@@ -119,15 +117,20 @@ FragPipe is open source and the output is currently supported by the following s
119117
#### Key references
120118
##### Database search
121119
- Kong, A. T., Leprevost, F. V., Avtonomov, D. M., Mellacheruvu, D., & Nesvizhskii, A. I. (2017). MSFragger: ultrafast and comprehensive peptide identification in mass spectrometry–based proteomics. Nature Methods, 14(5), 513-520.
122-
- Yu, F., Teo, G. C., Kong, A. T., Haynes, S. E., Avtonomov, D. M., Geiszler, D. J., & Nesvizhskii, A. I. (2020). Identification of modified peptides using localization-aware open search. Nature Communications, 11(1), 1-9.
120+
- Yu, F., Teo, G. C., Kong, A. T., Haynes, S. E., Avtonomov, D. M., Geiszler, D. J., & Nesvizhskii, A. I. (2020). Identification of modified peptides using localization-aware open search. Nature Communications, 11, 4065.
123121
- Yu, F., Haynes, S. E., Teo, G. C., Avtonomov, D. M., Polasky, D. A., & Nesvizhskii, A. I. (2020). Fast quantitative analysis of timsTOF PASEF data with MSFragger and IonQuant. Molecular & Cellular Proteomics, 10(9), 1575-1585.
124122
- Teo, G. C., Polasky, D. A., Yu, F., Nesvizhskii, A. I. (2020). A fast deisotoping algorithm and its implementation in the MSFragger search engine. Journal of Proteome Research, 20(1), 498-505.
125123

126124

125+
##### Chimeric spectra search
126+
- Yu, F., Deng, Y. & Nesvizhskii, A.I. (2025). MSFragger-DDA+ enhances peptide identification sensitivity with full isolation window search. Nature Communications, 16, 3329.
127+
128+
127129
##### Glyco/Labile search
128130
- Polasky, D. A., Yu, F., Teo, G. C., & Nesvizhskii, A. I. (2020). Fast and Comprehensive N-and O-glycoproteomics analysis with MSFragger-Glyco. Nature Methods, 17, 1125-1132.
129131
- Polasky, D. A., Geiszler, D. J., Yu, F., & Nesvizhskii, A. I. (2022). Multiattribute Glycan Identification and FDR Control for Glycoproteomics. Molecular & Cellular Proteomics, 21(3), 100205.
130132
- Polasky, D. A., Geiszler, D. J., Yu, F., Kai, Li., Teo, G. C., & Nesvizhskii, A. I. (2023). MSFragger-Labile: A Flexible Method to Improve Labile PTM Analysis in Proteomics. Molecular & Cellular Proteomics, 22(5), 100538.
133+
- Polasky, D. A., Lu, L., Yu, F., Li, K., Shortreed, M. R., Smith, L. M., & Nesvizhskii, A. I. (2025). Quantitative proteome-wide O-glycoproteomics analysis with FragPipe. Analytical and Bioanalytical Chemistry, 417(5), 921-930.
131134

132135

133136
##### PTM
@@ -138,7 +141,11 @@ FragPipe is open source and the output is currently supported by the following s
138141

139142
##### DIA
140143
- Tsou, C. C., Avtonomov, D., Larsen, B., Tucholska, M., Choi, H., Gingras, A. C., & Nesvizhskii, A. I. (2015). DIA-Umpire: comprehensive computational framework for data-independent acquisition proteomics. Nature methods, 12(3), 258-264.
141-
- Yu, F, Teo, G. C., Kong, A. T., Fröhlich, K., Li, G. X. , Demichev, V, Nesvizhskii, A..I. (2023). Analysis of DIA proteomics data using MSFragger-DIA and FragPipe computational platform, Nature Communications 14:4154.
144+
- Yu, F, Teo, G. C., Kong, A. T., Fröhlich, K., Li, G. X. , Demichev, V, Nesvizhskii, A..I. (2023). Analysis of DIA proteomics data using MSFragger-DIA and FragPipe computational platform, Nature Communications 14, 4154.
145+
146+
147+
##### DIA-PASEF
148+
- Li, K., Teo, G. C., Yang, K. L., Yu, F., & Nesvizhskii, A. I. (2025). diaTracer enables spectrum-centric analysis of diaPASEF proteomics data. Nature Communications, 16, 95.
142149

143150

144151
##### DDA quantification
@@ -154,26 +161,13 @@ FragPipe is open source and the output is currently supported by the following s
154161

155162
#### Building from scratch
156163

157-
1. Update build version:
158-
The version of the build is stored in 3 separate places:
159-
- File: `MSFragger-GUI/src/umich/msfragger/gui/Bundle.properties`
160-
Property: `msfragger.gui.version`
161-
- File: `MSFragger-GUI/build.gradle`
162-
Property: `version`
163-
- File: `MSFragger-GUI/src/umich/msfragger/gui/Bundle.properties `
164-
Property: `msfragger.gui.version`
165-
2. Build:
166164
You don't need to have Gradle installed, the Gradle wrapper included in this repository will be used. From the root directory of the repository issue the following commands:
167165

168-
```bash
169-
cd ./MSFragger-GUI
170-
./gradlew makeReleaseZipNoJre
171-
```
172-
or use this version to build with Java Runtime (for Windows only):
173-
174-
```bash
175-
cd ./MSFragger-GUI
176-
./gradlew makeReleaseZipWithJre
177-
```
166+
```bash
167+
cd FragPipe-GUI
168+
./gradlew makeReleaseInstaller # for Windows
169+
./gradlew makeReleaseZipLinux # for Linux
170+
```
178171

179-
3. The .zip output will be in `MSFragger-GUI/build/github-release`.
172+
The `FragPipe-x.x-Installer.exe` will be in the `FragPipe-GUI/build/installer` directory.
173+
The `FragPipe-x.x-linux.zip` will be in the `FragPipe-GUI/build/github-release` directory.

0 commit comments

Comments
 (0)