Data model of MzTab files. Please see the official MzTab specification at https://code.google.com/p/mztab/. More...
#include <OpenMS/FORMAT/MzTab.h>
Classes | |
class | CMMzTabStream |
class | IDMzTabStream |
Static Public Member Functions | |
static void | addMetaInfoToOptionalColumns (const std::set< String > &keys, std::vector< MzTabOptionalColumnEntry > &opt, const String &id, const MetaInfoInterface &meta) |
static std::map< Size, MzTabModificationMetaData > | generateMzTabStringFromModifications (const std::vector< String > &mods) |
static std::map< Size, MzTabModificationMetaData > | generateMzTabStringFromVariableModifications (const std::vector< String > &mods) |
static std::map< Size, MzTabModificationMetaData > | generateMzTabStringFromFixedModifications (const std::vector< String > &mods) |
static MzTab | exportFeatureMapToMzTab (const FeatureMap &feature_map, const String &filename) |
static MzTab | exportIdentificationsToMzTab (const std::vector< ProteinIdentification > &prot_ids, const std::vector< PeptideIdentification > &peptide_ids, const String &filename, bool first_run_inference_only, bool export_empty_pep_ids=false, bool export_all_psms=false, const String &title="ID export from OpenMS") |
Export peptide and protein identifications to mzTab. More... | |
static MzTabModificationList | extractModificationList (const PeptideHit &pep_hit, const std::vector< String > &fixed_mods, const std::vector< String > &localization_mods) |
static MzTab | exportConsensusMapToMzTab (const ConsensusMap &consensus_map, const String &filename, const bool first_run_inference_only, const bool export_unidentified_features, const bool export_unassigned_ids, const bool export_subfeatures, const bool export_empty_pep_ids=false, const bool export_all_psms=false, const String &title="ConsensusMap export from OpenMS") |
export linked peptide features aka consensus map More... | |
Static Protected Member Functions | |
static std::map< String, Size > | mapIDRunIdentifier2IDRunIndex_ (const std::vector< const ProteinIdentification * > &prot_ids) |
static std::optional< MzTabPSMSectionRow > | PSMSectionRowFromPeptideID_ (PeptideIdentification const &pid, std::vector< ProteinIdentification const * > const &prot_id, std::map< String, size_t > &idrun_2_run_index, std::map< std::pair< size_t, size_t >, size_t > &map_run_fileidx_2_msfileidx, std::map< Size, std::vector< std::pair< String, String >>> &run_to_search_engines, Size const current_psm_idx, Size const psm_id, MzTabString const &db, MzTabString const &db_version, bool const export_empty_pep_ids, bool const export_all_psms) |
static MzTabPeptideSectionRow | peptideSectionRowFromConsensusFeature_ (const ConsensusFeature &c, const ConsensusMap &consensus_map, const StringList &ms_runs, const Size n_study_variables, const std::set< String > &consensus_feature_user_value_keys, const std::set< String > &peptide_identifications_user_value_keys, const std::set< String > &peptide_hit_user_value_keys, const std::map< String, size_t > &idrun_2_run_index, const std::map< std::pair< size_t, size_t >, size_t > &map_run_fileidx_2_msfileidx, const std::map< std::pair< String, unsigned >, unsigned > &path_label_to_assay, const std::vector< String > &fixed_mods, bool export_subfeatures) |
static MzTabPeptideSectionRow | peptideSectionRowFromFeature_ (const Feature &c, const std::set< String > &feature_user_value_keys, const std::set< String > &peptide_identifications_user_value_keys, const std::set< String > &peptide_hit_user_value_keys, const std::vector< String > &fixed_mods) |
static MzTabProteinSectionRow | proteinSectionRowFromProteinHit_ (const ProteinHit &hit, const MzTabString &db, const MzTabString &db_version, const std::set< String > &protein_hit_user_value_keys) |
static MzTabProteinSectionRow | nextProteinSectionRowFromProteinGroup_ (const ProteinIdentification::ProteinGroup &group, const MzTabString &db, const MzTabString &db_version) |
static MzTabProteinSectionRow | nextProteinSectionRowFromIndistinguishableGroup_ (const std::vector< ProteinHit > &protein_hits, const ProteinIdentification::ProteinGroup &group, const size_t g, const std::map< Size, std::set< Size >> &ind2prot, const MzTabString &db, const MzTabString &db_version) |
static void | addMSRunMetaData_ (const std::map< size_t, String > &msrunindex_2_msfilename, MzTabMetaData &meta_data) |
static void | mapBetweenMSFileNameAndMSRunIndex_ (const std::vector< const ProteinIdentification * > &prot_ids, bool skip_first, std::map< String, size_t > &msfilename_2_msrunindex, std::map< size_t, String > &msrunindex_2_msfilename) |
static size_t | getQuantStudyVariables_ (const ProteinIdentification &pid) |
static MzTabParameter | getProteinScoreType_ (const ProteinIdentification &prot_id) |
static void | getConsensusMapMetaValues_ (const ConsensusMap &consensus_map, std::set< String > &consensus_feature_user_value_keys, std::set< String > &peptide_identification_user_value_keys, std::set< String > &peptide_hit_user_value_keys) |
static void | getFeatureMapMetaValues_ (const FeatureMap &feature_map, std::set< String > &feature_user_value_keys, std::set< String > &peptide_identification_user_value_keys, std::set< String > &peptide_hit_user_value_keys) |
static void | getIdentificationMetaValues_ (const std::vector< const ProteinIdentification * > &prot_ids, std::vector< const PeptideIdentification * > &peptide_ids_, std::set< String > &protein_hit_user_value_keys, std::set< String > &peptide_id_user_value_keys, std::set< String > &peptide_hit_user_value_keys) |
static MzTabParameter | getMSRunSpectrumIdentifierType_ (const std::vector< const PeptideIdentification * > &peptide_ids_) |
static void | mapBetweenRunAndSearchEngines_ (const std::vector< const ProteinIdentification * > &prot_ids, const std::vector< const PeptideIdentification * > &pep_ids, bool skip_first_run, std::map< std::tuple< String, String, String >, std::set< Size >> &search_engine_to_runs, std::map< Size, std::vector< std::pair< String, String >>> &run_to_search_engines, std::map< Size, std::vector< std::vector< std::pair< String, String >>>> &run_to_search_engines_settings, std::map< String, std::vector< std::pair< String, String >>> &search_engine_to_settings) |
static std::map< Size, std::set< Size > > | mapGroupsToProteins_ (const std::vector< ProteinIdentification::ProteinGroup > &groups, const std::vector< ProteinHit > &proteins) |
static void | addSearchMetaData_ (const std::vector< const ProteinIdentification * > &prot_ids, const std::map< std::tuple< String, String, String >, std::set< Size >> &search_engine_to_runs, const std::map< String, std::vector< std::pair< String, String >>> &search_engine_to_settings, MzTabMetaData &meta_data, bool first_run_inference_only) |
static void | mapIDRunFileIndex2MSFileIndex_ (const std::vector< const ProteinIdentification * > &prot_ids, const std::map< String, size_t > &msfilename_2_msrunindex, bool skip_first_run, std::map< std::pair< size_t, size_t >, size_t > &map_run_fileidx_2_msfileidx) |
static void | getSearchModifications_ (const std::vector< const ProteinIdentification * > &prot_ids, StringList &var_mods, StringList &fixed_mods) |
static MzTabString | getModificationIdentifier_ (const ResidueModification &r) |
static void | checkSequenceUniqueness_ (const std::vector< PeptideIdentification > &curr_pep_ids) |
Protected Attributes | |
MzTabMetaData | meta_data_ |
MzTabProteinSectionRows | protein_data_ |
MzTabPeptideSectionRows | peptide_data_ |
MzTabPSMSectionRows | psm_data_ |
MzTabSmallMoleculeSectionRows | small_molecule_data_ |
MzTabNucleicAcidSectionRows | nucleic_acid_data_ |
MzTabOligonucleotideSectionRows | oligonucleotide_data_ |
MzTabOSMSectionRows | osm_data_ |
/ oligonucleotide-spectrum matches More... | |
std::vector< Size > | empty_rows_ |
index of empty rows More... | |
std::map< Size, String > | comment_rows_ |
comments More... | |
Additional Inherited Members | |
![]() | |
template<typename SectionRows > | |
std::vector< String > | getOptionalColumnNames_ (const SectionRows &rows) const |
Helper function for "get...OptionalColumnNames" functions. More... | |
Data model of MzTab files. Please see the official MzTab specification at https://code.google.com/p/mztab/.
|
default |
Default constructor.
|
default |
|
static |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
static |
export linked peptide features aka consensus map
consensus_map | data structure of the linked peptide features |
filename | input consensusXML file name |
first_run_inference_only | Is all protein inference information (groups and scores) stored in the first run? |
export_unidentified_features | Should not identified peptide features be exported? |
export_unassigned_ids | Should unassigned identifications be exported? |
export_subfeatures | The position of the consensus feature will always be exported. Should the individual subfeatures be exported as well? |
export_empty_pep_ids | Export spectra without PSMs as well? |
export_all_psms | Instead of just the best PSM per spectrum, should other PSMs be exported as well? |
title | The title for the metadata section |
|
static |
|
static |
Export peptide and protein identifications to mzTab.
Additionally this function fills two std::maps with mappings for external usage.
[in] | prot_ids | Data structure containing protein identifications |
[in] | peptide_ids | Data structure containing peptide identifications |
[in] | filename | Input idXML file name |
[in] | first_run_inference_only | Is all protein inference information (groups and scores) stored in the first run? |
[in] | export_empty_pep_ids | Export spectra without PSMs as well? |
[in] | export_all_psms | Instead of just the best PSM per spectrum, should other PSMs be exported as well? |
[in] | title | The title for the metadata section |
|
static |
Generate MzTab style list of PTMs from PeptideHit (PSM) object. All passed fixed modifications are not reported (as suggested by the standard for the PRT and PEP section). In contrast, all modifications are reported in the PSM section (see standard document for details). If meta values for modification localization are found, this information is added.
|
static |
|
static |
|
static |
|
staticprotected |
const std::vector<Size>& getEmptyRows | ( | ) | const |
|
staticprotected |
|
staticprotected |
const MzTabMetaData& getMetaData | ( | ) | const |
|
staticprotected |
|
staticprotected |
std::vector<String> getNucleicAcidOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
const MzTabNucleicAcidSectionRows& getNucleicAcidSectionRows | ( | ) | const |
Referenced by NucleicAcidSearchEngine::main_().
std::vector<String> getOligonucleotideOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
const MzTabOligonucleotideSectionRows& getOligonucleotideSectionRows | ( | ) | const |
Referenced by NucleicAcidSearchEngine::main_().
std::vector<String> getOSMOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
const MzTabOSMSectionRows& getOSMSectionRows | ( | ) | const |
Referenced by NucleicAcidSearchEngine::main_().
std::vector<String> getPeptideOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
MzTabPeptideSectionRows& getPeptideSectionRows | ( | ) |
const MzTabPeptideSectionRows& getPeptideSectionRows | ( | ) | const |
std::vector<String> getProteinOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
|
staticprotected |
MzTabProteinSectionRows& getProteinSectionRows | ( | ) |
const MzTabProteinSectionRows& getProteinSectionRows | ( | ) | const |
std::vector<String> getPSMOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
MzTabPSMSectionRows& getPSMSectionRows | ( | ) |
const MzTabPSMSectionRows& getPSMSectionRows | ( | ) | const |
|
staticprotected |
|
staticprotected |
std::vector<String> getSmallMoleculeOptionalColumnNames | ( | ) | const |
Extract opt_ (custom, optional column names)
const MzTabSmallMoleculeSectionRows& getSmallMoleculeSectionRows | ( | ) | const |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
|
staticprotected |
void setEmptyRows | ( | const std::vector< Size > & | empty | ) |
void setMetaData | ( | const MzTabMetaData & | md | ) |
void setNucleicAcidSectionRows | ( | const MzTabNucleicAcidSectionRows & | nasd | ) |
void setOligonucleotideSectionRows | ( | const MzTabOligonucleotideSectionRows & | onsd | ) |
void setOSMSectionRows | ( | const MzTabOSMSectionRows & | osd | ) |
void setPeptideSectionRows | ( | const MzTabPeptideSectionRows & | psd | ) |
void setProteinSectionRows | ( | const MzTabProteinSectionRows & | psd | ) |
void setPSMSectionRows | ( | const MzTabPSMSectionRows & | psd | ) |
void setSmallMoleculeSectionRows | ( | const MzTabSmallMoleculeSectionRows & | smsd | ) |
|
protected |
index of empty rows
|
protected |
|
protected |
|
protected |
|
protected |
/ oligonucleotide-spectrum matches
|
protected |
|
protected |
|
protected |
|
protected |