Skip to content

Commit 19bdce1

Browse files
committed
Update README according to version 23.0
1 parent 4eef5b6 commit 19bdce1

File tree

1 file changed

+30
-35
lines changed

1 file changed

+30
-35
lines changed

README.md

Lines changed: 30 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ FragPipe is a comprehensive computational platform designed for the analysis of
1313
#### FragPipe tutorials
1414
* [Using FragPipe](https://fragpipe.nesvilab.org/docs/tutorial_fragpipe.html) (general tutorial covering all FragPipe modules)
1515
* [Running FragPipe in command line interface](https://fragpipe.nesvilab.org/docs/tutorial_headless.html)
16+
* [Running multiple FragPipe jobs in Batch](https://fragpipe.nesvilab.org/docs/tutorial_batch.html)
1617
* [Pulling and running FragPipe using Docker](https://fragpipe.nesvilab.org/docs/tutorial_docker.html)
1718
* PTM discovery
1819
* [Open search](https://fragpipe.nesvilab.org/docs/tutorial_open.html)
@@ -70,36 +71,34 @@ _Bruker .d indicates ddaPASEF files from timsTOF, other Bruker .d files should b
7071
_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)._
7172
_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._
7273

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

7775
#### Additional Documentation
78-
Complete MSFragger documentation can be found on the [MSFragger wiki](https://github.com/Nesvilab/MSFragger/wiki).
79-
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/)
8085

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

9190
For other tools developed by Nesvizhskii lab, visit our website
9291
[nesvilab.org](http://www.nesvilab.org)
9392

9493
#### How to Run
9594
- **Windows**:
96-
- Double click the `FragPipe.exe` or `FragPipe.bat` from the `bin` folder
97-
- 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
9897
- **Linux**:
9998
- Run the `fragpipe` shell script (can double-click to run)
100-
- Or execute the command: `java -jar FragPipe-x.x.jar`
10199
- **Mac OS** (command line interface only):
102100
- Read [Pulling and running FragPipe using Docker](https://fragpipe.nesvilab.org/docs/tutorial_docker.html)
101+
103102

104103
#### Integration
105104
FragPipe is open source and the output is currently supported by the following software projects:
@@ -118,15 +117,20 @@ FragPipe is open source and the output is currently supported by the following s
118117
#### Key references
119118
##### Database search
120119
- 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.
121-
- 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.
122121
- 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.
123122
- 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.
124123

125124

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+
126129
##### Glyco/Labile search
127130
- 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.
128131
- 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.
129132
- 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.
130134

131135

132136
##### PTM
@@ -137,7 +141,11 @@ FragPipe is open source and the output is currently supported by the following s
137141

138142
##### DIA
139143
- 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.
140-
- 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.
141149

142150

143151
##### DDA quantification
@@ -153,26 +161,13 @@ FragPipe is open source and the output is currently supported by the following s
153161

154162
#### Building from scratch
155163

156-
1. Update build version:
157-
The version of the build is stored in 3 separate places:
158-
- File: `MSFragger-GUI/src/umich/msfragger/gui/Bundle.properties`
159-
Property: `msfragger.gui.version`
160-
- File: `MSFragger-GUI/build.gradle`
161-
Property: `version`
162-
- File: `MSFragger-GUI/src/umich/msfragger/gui/Bundle.properties `
163-
Property: `msfragger.gui.version`
164-
2. Build:
165164
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:
166165

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

178-
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)