Skip to content

Commit a0ef1a1

Browse files
daichengxinclaude
andcommitted
docs(qpx): update output docs and qpx schema defaults
- add qpx/ to output directory trees - drop verbose opt_ column explanations from docs - set best_per_spectrum_only default to true Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 521fe06 commit a0ef1a1

2 files changed

Lines changed: 6 additions & 36 deletions

File tree

docs/output.md

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ results_iso/
6060
├── pipeline_info/ # Nextflow pipeline information
6161
├── sdrf/ # SDRF files and configs
6262
├── quant_tables/ # Quantification tables and results
63+
├── qpx/ # qpx results
6364
└── pmultiqc/ # pMultiQC reports
6465
├── multiqc_data/
6566
└── multiqc_plots/
@@ -77,6 +78,7 @@ results_lfq/
7778
├── spectra/ # Spectra-related data (only present if --mzml_features is enabled)
7879
│ └── mzml_statistics/ # Statistics about mzML files
7980
├── quant_tables/ # Quantification tables and results
81+
├── qpx/ # qpx results
8082
└── pmultiqc/ # pMultiQC reports
8183
├── multiqc_data/
8284
└── multiqc_plots/
@@ -105,6 +107,7 @@ results_localize/
105107
├── pipeline_info/ # Nextflow pipeline information
106108
├── sdrf/ # SDRF files and configs
107109
├── quant_tables/ # Quantification tables and results
110+
├── qpx/ # qpx results
108111
└── pmultiqc/ # pMultiQC reports
109112
├── multiqc_plots/
110113
│ ├── svg/
@@ -139,6 +142,7 @@ results/
139142
│ ├── fdr_consensusid/ # FDR calculation results
140143
│ └── id_filter/ # Filtered identification results
141144
├── quant_tables/ # Quantification tables and results
145+
├── qpx/ # qpx results
142146
└── pmultiqc/ # pMultiQC reports
143147
├── multiqc_plots/
144148
│ ├── svg/
@@ -247,41 +251,6 @@ QPX is the published quantification artifact for both DDA-LFQ and DDA-ISO. It is
247251
channel labels. The dataset is published flat under `qpx/`, the same layout as the DIA-NN (`quantmsdiann`) QPX
248252
output. See the [QPX specification](https://bigbio.github.io/qpx/) for the view schemas and file layout.
249253

250-
Some explanations for optional ("opt\_") columns:
251-
252-
PRT section:
253-
254-
- opt_global_Posterior_Probability_score: As opposed to the best_search_engine_score columns (which usually represent an FDR [consult the MTD section]) this specifies the posterior probability for a protein or protein group as calculated by protein inference.
255-
- opt_global_nr_found_peptides: The number of found peptides for the protein (group). By default this counts unmodified peptide sequences (TODO double-check)
256-
- opt_global_cv_PRIDE:0000303_decoy_hit: If this was a real target hit or a decoy entry added artificially to the protein database.
257-
- opt_global_result_type:
258-
- single_protein: A protein that is uniquely distinguishable from others. Note: this could be a subsumable protein.
259-
- indistinguishable_protein_group: A group of proteins that share exactly the same set of observed peptides.
260-
- protein_details: A dummy entry for every protein belonging to either of the two classes above. In case of an indistinguishable group, it would otherwise not be possible to report unique sequence coverage information about each member of the group. Do not use these entries for quantitative information or scoring as they will be "null/empty". They shall only be used to extract auxiliary information if required.
261-
262-
PEP section:
263-
264-
- opt_global_cv_MS:1000889_peptidoform_sequence: The sequence of the best explanation of this feature/spectrum but with modifications.
265-
- opt_global_feature_id: A unique ID assigned by internal algorithms. E.g., for looking up additional information in the PSM section or other output files like consensusXML
266-
- opt_global_SpecEValue_score: Spectral E-Value for the best match for this peptide (from the MSGF search engine)
267-
- opt_global_q-value(\_score): Experiment-wide q-value of the best match. The exact interpretation depends on the FDR/q-value settings of the pipeline.
268-
- opt_global_cv_MS:1002217_decoy_peptide: If the peptide from the best match was a target peptide from the digest of the input protein database, or an annotated or generated decoy.
269-
- opt_global_mass_to_charge_study_variable[n]: The m/z of the precursor (isobaric) or the feature (LFQ) in study_variable (= usually sample) n.
270-
- opt_global_retention_time_study_variable[n]: The retention time in seconds of the precursor (isobaric) or the feature (LFQ) in study_variable (= usually sample) n.
271-
272-
PSM section:
273-
274-
- opt_global_FFId_category: Currently always "internal".
275-
- opt_global_feature_id: A unique ID assigned by internal algorithms. E.g., for looking up additional information in the PEP section or other output files like consensusXML.
276-
- opt_global_map_index: May be ignored. Should be a one-to-one correspondence between "ms_run" in which this PSM was found and the value in this column + 1.
277-
- opt_global_spectrum_reference: May be ignored. Should be a one-to-one correspondence between the second part of the spectra_ref column and this column.
278-
- opt_global_cv_MS:1000889_peptidoform_sequence: The sequence for this match including modifications.
279-
- opt_global_SpecEValue_score: Spectral E-Value for this match (from the MSGF search engine)
280-
- opt_global_q-value(\_score): Experiment-wide q-value. The exact interpretation depends on the FDR/q-value settings of the pipeline.
281-
- opt_global_cv_MS:1002217_decoy_peptide: If the peptide from this match was a target peptide from the digest of the input protein database, or an annotated or generated decoy.
282-
283-
Note that columns with scores heavily depend on the chosen search engines and rescoring tools and are better looked up in the documentation of the underlying tool.
284-
285254
#### MSstats post-processing (external)
286255

287256
The pipeline no longer runs MSstats post-processing. Instead, quantms produces MSstats-compatible input files (`quant_tables/*_msstats_in.csv`) that users can provide directly to MSstats outside the pipeline for normalization, imputation, and statistical analysis.

nextflow_schema.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -755,7 +755,8 @@
755755
},
756756
"best_per_spectrum_only": {
757757
"type": "boolean",
758-
"description": "After applying score:fdr, retain only the best-scoring PSM per spectrum (default: keep all hits, matching legacy PercolatorAdapter behaviour).",
758+
"description": "After applying score:fdr, retain only the best-scoring PSM per spectrum.",
759+
"default": true,
759760
"fa_icon": "far fa-check-square",
760761
"hidden": true
761762
}

0 commit comments

Comments
 (0)