Ms2IdentificationRate.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: Chris Bielow$
// $Authors: Patricia Scheil, Swenja Wagner$
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/QC/QCBase.h>
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/METADATA/PeptideIdentificationList.h>
#include <string>
#include <vector>
 
namespace OpenMS
{
  class FeatureMap;
  class MSExperiment;
  class MzTabMetaData;
  class PeptideIdentification;
 
  class OPENMS_DLLAPI Ms2IdentificationRate : public QCBase
  {
  public:
    struct IdentificationRateData {
      Size num_peptide_identification = 0;
      Size num_ms2_spectra = 0;
      double identification_rate = 0.;
    };
 
  private:
    const String name_ = "Ms2IdentificationRate";
 
    std::vector<IdentificationRateData> rate_result_;
 
    Size getMS2Count_(const MSExperiment& exp);
 
    /*
     * @brief Checks pepID for target/decoy
     *
     * Only checks the first (!) hit, all other hits are ignored
     * Is static so that it can be used with MapUtilities::applyFunctionOnPeptideIDs() without creating a new object for each ID
     *
     * @param[in] id             pepID to be checked
     * @param[in] all_targets    always returns true (if the hits aren't empty)
     * @return               true/false
     * @throws               MissingInformation if target/decoy annotation is missing
     */
    static bool isTargetPeptide_(const PeptideIdentification& id, bool all_targets);
 
    /*
     * @brief Calculates id-rate and writes the result into a IdentificationRateData object which is appended to rate_result_
     *
     * @param[in] ms2_spectra_count  number of found ms2 spectra
     * @param[in] pep_ids_count      number of found (target) peptide identifications
     */
    void writeResults_(Size pep_ids_count, Size ms2_spectra_count);
 
  public:
    Ms2IdentificationRate() = default;
 
    virtual ~Ms2IdentificationRate() = default;
 
    void compute(const FeatureMap& feature_map, const MSExperiment& exp, bool assume_all_target = false);
 
    void compute(const PeptideIdentificationList& pep_ids, const MSExperiment& exp, bool assume_all_target = false);
 
    const String& getName() const override;
 
    const std::vector<IdentificationRateData>& getResults() const;
 
    QCBase::Status requirements() const override;
 
    void addMetaDataMetricsToMzTab(MzTabMetaData& meta) const;
  };
 
} // namespace OpenMS