MzTabFile.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/FORMAT/MzTab.h>
 
#include <OpenMS/METADATA/PeptideHit.h>
#include <OpenMS/METADATA/PeptideIdentification.h>
#include <OpenMS/METADATA/PeptideIdentificationList.h>
#include <OpenMS/METADATA/ProteinIdentification.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
#include <vector>
 
namespace OpenMS
{
  class SVOutStream;
  class OPENMS_DLLAPI MzTabFile
  {
  public:
    MzTabFile();
    ~MzTabFile();
 
    typedef std::map<std::pair<std::string, std::string>, std::vector<PeptideHit> > MapAccPepType;
 
    // store MzTab file
    void store(const std::string& filename, const MzTab& mz_tab) const;
 
    // stream IDs to file
    void store(
          const std::string& filename,
          const std::vector<ProteinIdentification>& protein_identifications,
          const PeptideIdentificationList& peptide_identifications,
          bool first_run_inference_only,
          bool export_empty_pep_ids = false,
          bool export_all_psms = false,
          const std::string& title = "ID export from OpenMS");
 
    // stream ConsensusMap to file
    void store(
      const std::string& filename, 
      const ConsensusMap& cmap,
      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;
 
    // Set store behaviour of optional "reliability" and "uri" columns (default=no)
    void storeProteinReliabilityColumn(bool store);
    void storePeptideReliabilityColumn(bool store);
    void storePSMReliabilityColumn(bool store);
    void storeSmallMoleculeReliabilityColumn(bool store);
    void storeProteinUriColumn(bool store);
    void storePeptideUriColumn(bool store);
    void storePSMUriColumn(bool store);
    void storeSmallMoleculeUriColumn(bool store);
    void storeProteinGoTerms(bool store);
 
    // load MzTab file
    void load(const std::string& filename, MzTab& mz_tab);
 
  protected:
    bool store_protein_reliability_;
    bool store_peptide_reliability_;
    bool store_psm_reliability_;
    bool store_smallmolecule_reliability_;
    bool store_protein_uri_;
    bool store_peptide_uri_;
    bool store_psm_uri_;
    bool store_smallmolecule_uri_;
    bool store_protein_goterms_;
    bool store_nucleic_acid_reliability_;
    bool store_oligonucleotide_reliability_;
    bool store_osm_reliability_;
    bool store_nucleic_acid_uri_;
    bool store_oligonucleotide_uri_;
    bool store_osm_uri_;
    bool store_nucleic_acid_goterms_;
 
    void generateMzTabMetaDataSection_(const MzTabMetaData& map, StringList& sl) const;
 
    std::string generateMzTabProteinHeader_(const MzTabProteinSectionRow& reference_row,
        const Size n_best_search_engine_scores,
        const std::vector<std::string>& optional_columns,
        const MzTabMetaData& meta,
        size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabProteinSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    std::string generateMzTabPeptideHeader_(Size search_ms_runs, Size n_best_search_engine_scores, Size n_search_engine_score, Size assays, Size study_variables, const std::vector<std::string>& optional_columns, size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabPeptideSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    std::string generateMzTabPSMHeader_(Size n_search_engine_scores, const std::vector<std::string>& optional_columns, size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabPSMSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    std::string generateMzTabSmallMoleculeHeader_(Size search_ms_runs, Size n_best_search_engine_scores, Size n_search_engine_score, Size assays, Size study_variables, const std::vector<std::string>& optional_columns, size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabSmallMoleculeSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    std::string generateMzTabNucleicAcidHeader_(Size search_ms_runs, Size n_best_search_engine_scores, Size n_search_engine_scores, const std::vector<std::string>& optional_columns, size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabNucleicAcidSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    std::string generateMzTabOligonucleotideHeader_(Size search_ms_runs, Size n_best_search_engine_scores, Size n_search_engine_score, const std::vector<std::string>& optional_columns, size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabOligonucleotideSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    std::string generateMzTabOSMHeader_(Size n_search_engine_scores, const std::vector<std::string>& optional_columns, size_t& n_columns) const;
 
    std::string generateMzTabSectionRow_(const MzTabOSMSectionRow& row, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, size_t& n_columns) const;
 
    template <typename SectionRow> void generateMzTabSection_(const std::vector<SectionRow>& rows, const std::vector<std::string>& optional_columns, const MzTabMetaData& meta, StringList& output, size_t n_header_columns) const
    {
      output.reserve(output.size() + rows.size() + 1);
      for (const auto& row : rows)
      {
        size_t n_section_columns = 0;
        output.push_back(generateMzTabSectionRow_(row, optional_columns, meta, n_section_columns));
        if (n_header_columns != n_section_columns)  throw Exception::Postcondition(__FILE__, __LINE__, OPENMS_PRETTY_FUNCTION, "Header and content differs in columns. Please report this bug to the OpenMS developers.");
      }
    }
 
    // auxiliary functions
 
    static void addOptionalColumnsToSectionRow_(const std::vector<std::string>& column_names, const std::vector<MzTabOptionalColumnEntry>& column_entries, StringList& output);
 
    // extract two integers from string (e.g. search_engine_score[1]_ms_run[2] -> 1,2)
    static std::pair<int, int> extractIndexPairsFromBrackets_(const std::string& s);
 
    static void sortPSM_(PeptideIdentificationList::iterator begin, PeptideIdentificationList::iterator end);
 
    static void keepFirstPSM_(PeptideIdentificationList::iterator begin, PeptideIdentificationList::iterator end);
 
    static void partitionIntoRuns_(const PeptideIdentificationList& pep_ids,
                                   const std::vector<ProteinIdentification>& pro_ids,
                                   std::map<std::string, PeptideIdentificationList >& map_run_to_pepids,
                                   std::map<std::string, std::vector<ProteinIdentification> >& map_run_to_proids
                                   );
 
 
    static void createProteinToPeptideLinks_(const std::map<std::string, PeptideIdentificationList >& map_run_to_pepids, MapAccPepType& map_run_accession_to_pephits);
 
    static std::string extractProteinAccession_(const PeptideHit& peptide_hit);
 
    static std::string extractPeptideModifications_(const PeptideHit& peptide_hit);
 
    static std::string mapSearchEngineToCvParam_(const std::string& openms_search_engine_name);
 
    static std::string mapSearchEngineScoreToCvParam_(const std::string& openms_search_engine_name, double score, std::string score_type);
 
    static std::string extractNumPeptides_(const std::string& common_identifier, const std::string& protein_accession,
                                      const MapAccPepType& map_run_accession_to_peptides);
 
    // mzTab definition of distinct
    static std::string extractNumPeptidesDistinct_(std::string common_identifier, std::string protein_accession,
                                              const MapAccPepType& map_run_accession_to_peptides);
 
    // same as distinct but additional constraint of uniqueness (=maps to exactly one Protein)
    static std::string extractNumPeptidesUnambiguous_(std::string common_identifier, std::string protein_accession,
                                                 const MapAccPepType& map_run_accession_to_peptides);
 
    static std::map<std::string, Size> extractNumberOfSubSamples_(const std::map<std::string, std::vector<ProteinIdentification> >& map_run_to_proids);
 
    static void writePeptideHeader_(SVOutStream& output, std::map<std::string, Size> n_sub_samples);
 
    static void writeProteinHeader_(SVOutStream& output, std::map<std::string, Size> n_sub_samples);
 
    static void writeProteinData_(SVOutStream& output,
                                  const ProteinIdentification& prot_id,
                                  Size run_count,
                                  std::string input_filename,
                                  bool has_coverage,
                                  const MapAccPepType& map_run_accession_to_peptides,
                                  const std::map<std::string, Size>& map_run_to_num_sub
                                  );
 
  private:
    friend class MzTabMFile;
  };
 
} // namespace OpenMS