Skip to content

Commit 9d8b233

Browse files
authored
Update FragPipe Tool to Version 23.0 (#801)
* Updates for FragPipe version 23.0. * Updates for automated tests. * Increase profile version to 24.2 and fix version_command. * Small changes to standardize XML that don't affect behavior. Remove unnecessary str conversion. Indent koina-url parameter. Compare unset groupby parameter to 'None' as is done for other select parameters.
1 parent 0ac7534 commit 9d8b233

18 files changed

Lines changed: 1889 additions & 978 deletions

tools/fragpipe/fragpipe

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ while [[ $# -gt 0 ]]; do
2222
shift
2323
ionquant_key=$1
2424
;;
25+
--diatracer_key)
26+
shift
27+
diatracer_key=$1
28+
;;
2529
--workflow)
2630
fragpipe_args+=("$1")
2731
shift
@@ -35,16 +39,7 @@ while [[ $# -gt 0 ]]; do
3539
shift
3640
done
3741

38-
if [[ ! -z "$workflow_file" ]]; then
39-
# Because the DIA-NN license is incompatible with bioconda, we remove the feature.
40-
grep 'diann.run-dia-nn=true' "$workflow_file" >/dev/null
41-
if [[ $? -eq 0 ]]; then
42-
echo "Error: DIA-NN is disabled in the FragPipe bioconda package."
43-
exit 1
44-
fi
45-
fi
46-
47-
if [[ -z $msfragger_key || -z $ionquant_key ]]; then
42+
if [[ -z $msfragger_key || -z $ionquant_key || -z $diatracer_key ]]; then
4843
echo "$license_agreement_text"
4944
exit 1
5045
else
@@ -60,6 +55,12 @@ else
6055
echo "$license_agreement_text"
6156
exit 1
6257
fi
58+
diatracer --key $diatracer_key --help | grep 'License key verified' >/dev/null 2>&1
59+
if [[ $? -ne 0 ]]; then
60+
echo "Error: Invalid diaTracer license key"
61+
echo "$license_agreement_text"
62+
exit 1
63+
fi
6364
fi
6465

6566
sh fragpipe_local/bin/fragpipe "${fragpipe_args[@]}"

tools/fragpipe/fragpipe.xml

Lines changed: 94 additions & 154 deletions
Large diffs are not rendered by default.

tools/fragpipe/macros.xml

Lines changed: 446 additions & 52 deletions
Large diffs are not rendered by default.

tools/fragpipe/msfragger_macros.xml

Lines changed: 272 additions & 215 deletions
Large diffs are not rendered by default.

tools/fragpipe/test-data/default/outputs/workflow.txt renamed to tools/fragpipe/test-data/basic-search/outputs/workflow.txt

Lines changed: 84 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,34 @@
1+
# Workflow: Basic-Search
2+
3+
4+
crystalc.run-crystalc=false
5+
database.db-path=final_db.fas
16
database.decoy-tag=rev_
2-
diann.fragpipe.cmd-opts=
7+
diann.channel-normalization-strategy=0
8+
diann.cmd-opts=
9+
diann.generate-msstats=true
310
diann.heavy=
411
diann.library=
512
diann.light=
613
diann.medium=
14+
diann.min-site-prob=0.75
15+
diann.mod-tag=
716
diann.q-value=0.01
817
diann.quantification-strategy=3
18+
diann.quantification-strategy-2=2
919
diann.run-dia-nn=false
1020
diann.run-dia-plex=false
1121
diann.run-specific-protein-q-value=false
1222
diann.unrelated-runs=false
13-
diann.use-predicted-spectra=true
23+
diann.use-predicted-spectra=false
24+
diatracer.corr-threshold=0.3
25+
diatracer.delta-apex-im=0.01
26+
diatracer.delta-apex-rt=3
27+
diatracer.mass-defect-filter=true
28+
diatracer.mass-defect-offset=0.1
29+
diatracer.rf-max=500
30+
diatracer.run-diatracer=false
31+
diatracer.write-intermediate-files=false
1432
diaumpire.AdjustFragIntensity=true
1533
diaumpire.BoostComplementaryIon=false
1634
diaumpire.CorrThreshold=0
@@ -32,10 +50,19 @@ diaumpire.SE.MassDefectOffset=0.1
3250
diaumpire.SE.NoMissedScan=1
3351
diaumpire.SE.SN=1.1
3452
diaumpire.run-diaumpire=false
53+
fpop.coadaptr.fpop.fpop_masses=
54+
fpop.coadaptr.fpop.run-fpop-coadaptr=false
55+
fpop.fragpipe.fpop.fpop-tmt=false
56+
fpop.fragpipe.fpop.label_control=
57+
fpop.fragpipe.fpop.label_fpop=
58+
fpop.fragpipe.fpop.region_size=1
59+
fpop.fragpipe.fpop.run-fpop=false
60+
fpop.fragpipe.fpop.subtract-control=false
3561
freequant.mz-tol=10
3662
freequant.rt-tol=0.4
3763
freequant.run-freequant=false
3864
ionquant.excludemods=
65+
ionquant.formula=
3966
ionquant.heavy=
4067
ionquant.imtol=0.05
4168
ionquant.ionfdr=0.01
@@ -49,7 +76,7 @@ ionquant.mbrrttol=1
4976
ionquant.mbrtoprun=10
5077
ionquant.medium=
5178
ionquant.minfreq=0
52-
ionquant.minions=2
79+
ionquant.minions=1
5380
ionquant.minisotopes=2
5481
ionquant.minscans=3
5582
ionquant.mztol=10
@@ -64,15 +91,24 @@ ionquant.uniqueness=0
6491
ionquant.use-labeling=false
6592
ionquant.use-lfq=true
6693
ionquant.writeindex=0
94+
msbooster.find-best-im-model=false
95+
msbooster.find-best-rt-model=false
96+
msbooster.find-best-spectra-model=false
97+
msbooster.fragmentation-type=0
98+
msbooster.im-model=DIA-NN
99+
msbooster.koina-url=
100+
msbooster.predict-im=true
67101
msbooster.predict-rt=true
68102
msbooster.predict-spectra=true
103+
msbooster.rt-model=DIA-NN
69104
msbooster.run-msbooster=false
70-
msbooster.use-correlated-features=false
105+
msbooster.spectra-model=DIA-NN
106+
msbooster.spectral-library-path=
71107
msfragger.Y_type_masses=
72108
msfragger.activation_types=all
73-
msfragger.add_topN_complementary=0
74109
msfragger.allowed_missed_cleavage_1=2
75110
msfragger.allowed_missed_cleavage_2=2
111+
msfragger.analyzer_types=all
76112
msfragger.calibrate_mass=2
77113
msfragger.check_spectral_files=true
78114
msfragger.clip_nTerm_M=true
@@ -94,6 +130,7 @@ msfragger.labile_search_mode=off
94130
msfragger.localize_delta_mass=false
95131
msfragger.mass_diff_to_variable_mod=0
96132
msfragger.mass_offsets=0
133+
msfragger.mass_offsets_detailed=
97134
msfragger.max_fragment_charge=2
98135
msfragger.max_variable_mods_combinations=5000
99136
msfragger.max_variable_mods_per_peptide=3
@@ -104,8 +141,8 @@ msfragger.minimum_peaks=15
104141
msfragger.minimum_ratio=0.01
105142
msfragger.misc.fragger.clear-mz-hi=0.0
106143
msfragger.misc.fragger.clear-mz-lo=0.0
107-
msfragger.misc.fragger.digest-mass-hi=5000
108-
msfragger.misc.fragger.digest-mass-lo=500
144+
msfragger.misc.fragger.digest-mass-hi=5000.0
145+
msfragger.misc.fragger.digest-mass-lo=500.0
109146
msfragger.misc.fragger.enzyme-dropdown-1=stricttrypsin
110147
msfragger.misc.fragger.enzyme-dropdown-2=null
111148
msfragger.misc.fragger.precursor-charge-hi=4
@@ -117,8 +154,8 @@ msfragger.num_enzyme_termini=2
117154
msfragger.output_format=pepXML_pin
118155
msfragger.output_max_expect=50.0
119156
msfragger.output_report_topN=1
157+
msfragger.output_report_topN_dda_plus=5
120158
msfragger.output_report_topN_dia1=5
121-
msfragger.output_report_topN_dia2=3
122159
msfragger.override_charge=false
123160
msfragger.precursor_mass_lower=-20
124161
msfragger.precursor_mass_mode=selected
@@ -142,16 +179,17 @@ msfragger.search_enzyme_nocut_2=
142179
msfragger.search_enzyme_sense_1=C
143180
msfragger.search_enzyme_sense_2=C
144181
msfragger.table.fix-mods=0.0,C-Term Peptide,true,-1; 0.0,N-Term Peptide,true,-1; 0.0,C-Term Protein,true,-1; 0.0,N-Term Protein,true,-1; 0.0,G (glycine),true,-1; 0.0,A (alanine),true,-1; 0.0,S (serine),true,-1; 0.0,P (proline),true,-1; 0.0,V (valine),true,-1; 0.0,T (threonine),true,-1; 57.02146,C (cysteine),true,-1; 0.0,L (leucine),true,-1; 0.0,I (isoleucine),true,-1; 0.0,N (asparagine),true,-1; 0.0,D (aspartic acid),true,-1; 0.0,Q (glutamine),true,-1; 0.0,K (lysine),true,-1; 0.0,E (glutamic acid),true,-1; 0.0,M (methionine),true,-1; 0.0,H (histidine),true,-1; 0.0,F (phenylalanine),true,-1; 0.0,R (arginine),true,-1; 0.0,Y (tyrosine),true,-1; 0.0,W (tryptophan),true,-1; 0.0,B ,true,-1; 0.0,J,true,-1; 0.0,O,true,-1; 0.0,U,true,-1; 0.0,X,true,-1; 0.0,Z,true,-1
145-
msfragger.table.var-mods=15.9949,M,true,3; 42.0106,[^,true,1; 79.96633,STY,false,3; -17.0265,nQnC,false,1; -18.0106,nE,false,1; 4.025107,K,false,2; 6.020129,R,false,2; 8.014199,K,false,2; 10.008269,R,false,2; 0.0,site_10,false,1; 0.0,site_11,false,1; 0.0,site_12,false,1; 0.0,site_13,false,1; 0.0,site_14,false,1; 0.0,site_15,false,1; 0.0,site_16,false,1
182+
msfragger.table.var-mods=15.99491461956,M,true,3; 42.0105646837,[^,true,1
146183
msfragger.track_zero_topN=0
147184
msfragger.use_all_mods_in_first_search=false
185+
msfragger.use_detailed_offsets=false
148186
msfragger.use_topN_peaks=150
149187
msfragger.write_calibrated_mzml=false
150-
msfragger.write_uncalibrated_mgf=false
151188
msfragger.zero_bin_accept_expect=0
152189
msfragger.zero_bin_mult_expect=1
153190
opair.activation1=HCD
154191
opair.activation2=ETD
192+
opair.allowed_sites=
155193
opair.filterOxonium=true
156194
opair.glyco_db=
157195
opair.max_glycans=4
@@ -174,14 +212,14 @@ percolator.run-percolator=true
174212
phi-report.dont-use-prot-proph-file=false
175213
phi-report.filter=--sequential --picked --prot 0.01
176214
phi-report.pep-level-summary=false
177-
phi-report.philosoher-msstats=false
178215
phi-report.print-decoys=false
179216
phi-report.prot-level-summary=true
180217
phi-report.remove-contaminants=false
181218
phi-report.run-report=true
182219
protein-prophet.cmd-opts=--maxppmdiff 2000000 --minprob 0.05
183220
protein-prophet.run-protein-prophet=true
184-
ptmprophet.cmdline=KEEPOLD STATIC EM\=1 NIONS\=b M\:15.9949,n\:42.0106 MINPROB\=0.5
221+
ptmprophet.cmdline=NOSTACK KEEPOLD STATIC FRAGPPMTOL\=10 EM\=1 NIONS\=b M\:15.9949,n\:42.0106 MINPROB\=0.5
222+
ptmprophet.override-defaults=false
185223
ptmprophet.run-ptmprophet=false
186224
ptmshepherd.adv_params=false
187225
ptmshepherd.annotation-common=false
@@ -193,22 +231,18 @@ ptmshepherd.annotation_tol=0.01
193231
ptmshepherd.cap_y_ions=
194232
ptmshepherd.decoy_type=1
195233
ptmshepherd.diag_ions=
196-
ptmshepherd.diagextract_mode=false
197234
ptmshepherd.diagmine_diagMinFoldChange=3.0
198235
ptmshepherd.diagmine_diagMinSpecDiff=00.2
199236
ptmshepherd.diagmine_fragMinFoldChange=3.0
200237
ptmshepherd.diagmine_fragMinPropensity=00.1
201238
ptmshepherd.diagmine_fragMinSpecDiff=00.1
202239
ptmshepherd.diagmine_minIonsPerSpec=2
203240
ptmshepherd.diagmine_minPeps=25
204-
ptmshepherd.diagmine_mode=false
205241
ptmshepherd.diagmine_pepMinFoldChange=3.0
206242
ptmshepherd.diagmine_pepMinSpecDiff=00.2
207-
ptmshepherd.glyco_adducts=
208243
ptmshepherd.glyco_fdr=1.00
209244
ptmshepherd.glyco_isotope_max=3
210245
ptmshepherd.glyco_isotope_min=-1
211-
ptmshepherd.glyco_mode=false
212246
ptmshepherd.glyco_ppm_tol=50
213247
ptmshepherd.glycodatabase=
214248
ptmshepherd.histo_smoothbins=2
@@ -218,9 +252,9 @@ ptmshepherd.iontype_c=true
218252
ptmshepherd.iontype_x=false
219253
ptmshepherd.iontype_y=true
220254
ptmshepherd.iontype_z=true
255+
ptmshepherd.iterloc_maxEpoch=100
256+
ptmshepherd.iterloc_mode=false
221257
ptmshepherd.localization_allowed_res=
222-
ptmshepherd.localization_background=4
223-
ptmshepherd.max_adducts=0
224258
ptmshepherd.n_glyco=true
225259
ptmshepherd.normalization-psms=true
226260
ptmshepherd.normalization-scans=false
@@ -232,28 +266,41 @@ ptmshepherd.peakpicking_width=0.002
232266
ptmshepherd.precursor_mass_units=0
233267
ptmshepherd.precursor_tol=0.01
234268
ptmshepherd.print_decoys=false
235-
ptmshepherd.prob_dhexOx=2,0.5,0.1
236-
ptmshepherd.prob_dhexY=2,0.5
237-
ptmshepherd.prob_neuacOx=2,0.05,0.2
238-
ptmshepherd.prob_neugcOx=2,0.05,0.2
239-
ptmshepherd.prob_phosphoOx=2,0.05,0.2
240-
ptmshepherd.prob_regY=5,0.5
241-
ptmshepherd.prob_sulfoOx=2,0.05,0.2
269+
ptmshepherd.print_full_glyco_params=false
270+
ptmshepherd.prob_mass=0.5
242271
ptmshepherd.remainder_masses=
243272
ptmshepherd.remove_glycan_delta_mass=true
244273
ptmshepherd.run-shepherd=false
274+
ptmshepherd.run_diagextract_mode=false
275+
ptmshepherd.run_diagmine_mode=false
276+
ptmshepherd.run_glyco_mode=false
277+
ptmshepherd.spectra_condPeaks=150
278+
ptmshepherd.spectra_condRatio=0.0001
279+
ptmshepherd.spectra_maxPrecursorCharge=4
245280
ptmshepherd.spectra_maxfragcharge=2
246281
ptmshepherd.spectra_ppmtol=20
247282
ptmshepherd.varmod_masses=
248283
quantitation.run-label-free-quant=false
249284
run-psm-validation=true
250285
run-validation-tab=true
251-
saintexpress.fragpipe.cmd-opts=
286+
saintexpress.cmd-opts=
252287
saintexpress.max-replicates=10
253288
saintexpress.run-saint-express=false
254289
saintexpress.virtual-controls=100
290+
skyline.run-skyline=false
291+
skyline.skyline=false
292+
skyline.skyline-custom=false
293+
skyline.skyline-custom-path=
294+
skyline.skyline-daily=true
295+
skyline.skyline-fragment-tolerance=10
296+
skyline.skyline-mods-mode=Default
297+
skyline.skyline-precursor-tolerance=10
298+
skyline.use-ssl=false
299+
speclibgen.convert-pepxml=true
300+
speclibgen.convert-psm=false
255301
speclibgen.easypqp.extras.max_delta_ppm=15
256302
speclibgen.easypqp.extras.max_delta_unimod=0.02
303+
speclibgen.easypqp.extras.max_glycan_qval=1
257304
speclibgen.easypqp.extras.rt_lowess_fraction=0
258305
speclibgen.easypqp.fragment.a=false
259306
speclibgen.easypqp.fragment.b=true
@@ -262,6 +309,7 @@ speclibgen.easypqp.fragment.x=false
262309
speclibgen.easypqp.fragment.y=true
263310
speclibgen.easypqp.fragment.z=false
264311
speclibgen.easypqp.im-cal=Automatic selection of a run as reference IM
312+
speclibgen.easypqp.labile_mode=Regular (not glyco)
265313
speclibgen.easypqp.neutral_loss=false
266314
speclibgen.easypqp.rt-cal=ciRT
267315
speclibgen.easypqp.select-file.text=
@@ -270,6 +318,7 @@ speclibgen.keep-intermediate-files=false
270318
speclibgen.run-speclibgen=false
271319
tab-run.delete_calibrated_mzml=false
272320
tab-run.delete_temp_files=false
321+
tab-run.export_matched_fragments=false
273322
tab-run.sub_mzml_prob_threshold=0.5
274323
tab-run.write_sub_mzml=false
275324
tmtintegrator.add_Ref=-1
@@ -278,24 +327,28 @@ tmtintegrator.allow_overlabel=true
278327
tmtintegrator.allow_unlabeled=true
279328
tmtintegrator.best_psm=true
280329
tmtintegrator.channel_num=TMT-6
281-
tmtintegrator.dont-run-fq-lq=false
330+
tmtintegrator.extraction_tool=IonQuant
282331
tmtintegrator.glyco_qval=-1
283-
tmtintegrator.groupby=0
332+
tmtintegrator.groupby=-1
284333
tmtintegrator.log2transformed=true
285334
tmtintegrator.max_pep_prob_thres=0
286335
tmtintegrator.min_ntt=0
287336
tmtintegrator.min_pep_prob=0.9
288337
tmtintegrator.min_percent=0.05
289338
tmtintegrator.min_purity=0.5
339+
tmtintegrator.min_resolution=0
290340
tmtintegrator.min_site_prob=-1
341+
tmtintegrator.min_snr=0
291342
tmtintegrator.mod_tag=none
292343
tmtintegrator.ms1_int=true
293344
tmtintegrator.outlier_removal=true
345+
tmtintegrator.philosopher-msstats=false
294346
tmtintegrator.print_RefInt=false
295347
tmtintegrator.prot_exclude=none
296348
tmtintegrator.prot_norm=0
297349
tmtintegrator.psm_norm=false
298350
tmtintegrator.quant_level=2
351+
tmtintegrator.ref_d_tag=Pool
299352
tmtintegrator.ref_tag=Bridge
300353
tmtintegrator.run-tmtintegrator=false
301354
tmtintegrator.tolerance=20
@@ -305,4 +358,6 @@ tmtintegrator.unique_pep=false
305358
tmtintegrator.use_glycan_composition=false
306359
workflow.input.data-type.im-ms=false
307360
workflow.input.data-type.regular-ms=true
308-
workflow.saved-with-ver=20.0-build5
361+
workflow.misc.save-sdrf=true
362+
workflow.misc.sdrf-type=Default
363+
workflow.saved-with-ver=23.0-build14
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)