|
| void | registerOptionsAndFlags_ () override |
| | Sets the valid command line options (with argument) and flags (without argument).
|
| |
| set< ConstRibonucleotidePtr > | getModifications_ (const set< std::string > &mod_names) |
| |
| AdductInfo | parseAdduct_ (const std::string &adduct) |
| |
| void | deisotopeAndSingleChargeMSSpectrum_ (MSSpectrum &in, Int min_charge, Int max_charge, double fragment_tolerance, bool fragment_unit_ppm, bool keep_only_deisotoped=false, Size min_isopeaks=3, Size max_isopeaks=10, bool make_single_charged=true) |
| |
| void | preprocessSpectra_ (PeakMap &exp, double fragment_mass_tolerance, bool fragment_mass_tolerance_unit_ppm, bool single_charge_spectra, bool negative_mode, Int min_charge, Int max_charge, bool include_unknown_charge) |
| |
| double | calculatePrecursorMass_ (double mz, Int charge, Int isotope, double adduct_mass, bool negative_mode) |
| |
| void | resolveAmbiguousMods_ (HitsByScore &hits) |
| |
| void | postProcessHits_ (const PeakMap &exp, vector< HitsByScore > &annotated_hits, IdentificationData &id_data, bool negative_mode) |
| |
| void | calculateAndFilterFDR_ (IdentificationData &id_data, bool only_top_hits) |
| |
| void | generateLFQInput_ (IdentificationData &id_data, const std::string &out_file) |
| |
| ExitCodes | main_ (int, const char **) override |
| | The actual "main" method. main_() is invoked by main().
|
| |
| std::string | getParamArgument_ (const Param::ParamEntry &entry) const |
| | Utility function that determines a suitable argument value for the given Param::ParamEntry.
|
| |
| std::vector< ParameterInformation > | paramToParameterInformation_ (const Param ¶m) const |
| | Translates the given parameter object into a vector of ParameterInformation, that can be utilized for cl parsing.
|
| |
| ParameterInformation | paramEntryToParameterInformation_ (const Param::ParamEntry &entry, const std::string &argument="", const std::string &full_name="") const |
| | Transforms a ParamEntry object to command line parameter (ParameterInformation).
|
| |
| void | registerParamSubsectionsAsTOPPSubsections_ (const Param ¶m) |
| |
| void | registerFullParam_ (const Param ¶m) |
| | Register command line parameters for all entries in a Param object.
|
| |
| void | registerStringOption_ (const std::string &name, const std::string &argument, const std::string &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers a string option.
|
| |
| void | setValidStrings_ (const std::string &name, const std::vector< std::string > &strings) |
| | Sets the valid strings for a string option or a whole string list.
|
| |
| void | setValidStrings_ (const std::string &name, const std::string vstrings[], int count) |
| | Sets the valid strings for a string option or a whole string list.
|
| |
| void | registerInputFile_ (const std::string &name, const std::string &argument, const std::string &default_value, const std::string &description, bool required=true, bool advanced=false, const StringList &tags=StringList()) |
| | Registers an input file option.
|
| |
| void | registerOutputFile_ (const std::string &name, const std::string &argument, const std::string &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers an output file option.
|
| |
| void | registerOutputPrefix_ (const std::string &name, const std::string &argument, const std::string &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers an output file prefix used for tools with multiple file output.
|
| |
| void | registerOutputDir_ (const std::string &name, const std::string &argument, const std::string &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers an output directory used for tools with multiple output files which are not an output file list, i.e. do not correspond to the number of input files.
|
| |
| void | setValidFormats_ (const std::string &name, const std::vector< std::string > &formats, const bool force_OpenMS_format=true) |
| | Sets the formats for a input/output file option or for all members of an input/output file lists.
|
| |
| void | registerDoubleOption_ (const std::string &name, const std::string &argument, double default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers a double option.
|
| |
| void | setMinInt_ (const std::string &name, Int min) |
| | Sets the minimum value for the integer parameter(can be a list of integers,too) name.
|
| |
| void | setMaxInt_ (const std::string &name, Int max) |
| | Sets the maximum value for the integer parameter(can be a list of integers,too) name.
|
| |
| void | setMinFloat_ (const std::string &name, double min) |
| | Sets the minimum value for the floating point parameter(can be a list of floating points,too) name.
|
| |
| void | setMaxFloat_ (const std::string &name, double max) |
| | Sets the maximum value for the floating point parameter(can be a list of floating points,too) name.
|
| |
| void | registerIntOption_ (const std::string &name, const std::string &argument, Int default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers an integer option.
|
| |
| void | registerIntList_ (const std::string &name, const std::string &argument, const IntList &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers a list of integers option.
|
| |
| void | registerDoubleList_ (const std::string &name, const std::string &argument, const DoubleList &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers a list of doubles option.
|
| |
| void | registerStringList_ (const std::string &name, const std::string &argument, const StringList &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers a list of strings option.
|
| |
| void | registerInputFileList_ (const std::string &name, const std::string &argument, const StringList &default_value, const std::string &description, bool required=true, bool advanced=false, const StringList &tags=StringList()) |
| | Registers a list of input files option.
|
| |
| void | registerOutputFileList_ (const std::string &name, const std::string &argument, const StringList &default_value, const std::string &description, bool required=true, bool advanced=false) |
| | Registers a list of output files option.
|
| |
| void | registerFlag_ (const std::string &name, const std::string &description, bool advanced=false) |
| | Registers a flag.
|
| |
| void | registerSubsection_ (const std::string &name, const std::string &description) |
| | Registers an allowed subsection in the INI file (usually from OpenMS algorithms).
|
| |
| void | registerTOPPSubsection_ (const std::string &name, const std::string &description) |
| | Registers an allowed subsection in the INI file originating from the TOPP tool itself.
|
| |
| void | addEmptyLine_ () |
| | Adds an empty line between registered variables in the documentation.
|
| |
| std::string | getStringOption_ (const std::string &name) const |
| | Returns the value of a previously registered string option (use getOutputDirOption() for output directories)
|
| |
| std::string | getOutputDirOption (const std::string &name) const |
| | Returns the value of a previously registered output_dir option.
|
| |
| double | getDoubleOption_ (const std::string &name) const |
| | Returns the value of a previously registered double option.
|
| |
| Int | getIntOption_ (const std::string &name) const |
| | Returns the value of a previously registered integer option.
|
| |
| StringList | getStringList_ (const std::string &name) const |
| | Returns the value of a previously registered StringList.
|
| |
| IntList | getIntList_ (const std::string &name) const |
| | Returns the value of a previously registered IntList.
|
| |
| DoubleList | getDoubleList_ (const std::string &name) const |
| | Returns the value of a previously registered DoubleList.
|
| |
| bool | getFlag_ (const std::string &name) const |
| | Returns the value of a previously registered flag.
|
| |
| const ParameterInformation & | findEntry_ (const std::string &name) const |
| | Finds the entry in the parameters_ array that has the name name.
|
| |
| Param const & | getParam_ () const |
| | Return all parameters relevant to this TOPP tool.
|
| |
| void | checkParam_ (const Param ¶m, const std::string &filename, const std::string &location) const |
| | Checks top-level entries of param according to the information during registration.
|
| |
| void | fileParamValidityCheck_ (const StringList ¶m_value, const std::string ¶m_name, const ParameterInformation &p) const |
| | checks if files of an input file list exist
|
| |
| void | fileParamValidityCheck_ (std::string ¶m_value, const std::string ¶m_name, const ParameterInformation &p) const |
| | checks if an input file exists (respecting the flags)
|
| |
| void | checkIfIniParametersAreApplicable_ (const Param &ini_params) |
| | Checks if the parameters of the provided ini file are applicable to this tool.
|
| |
| void | printUsage_ () |
| | Prints the tool-specific command line options and appends the common options.
|
| |
| void | writeLogInfo_ (const std::string &text) const |
| | Writes a string to the log file and to OPENMS_LOG_INFO.
|
| |
| void | writeLogWarn_ (const std::string &text) const |
| | Writes a string to the log file and to OPENMS_LOG_WARN.
|
| |
| void | writeLogError_ (const std::string &text) const |
| | Writes a string to the log file and to OPENMS_LOG_ERROR.
|
| |
| void | writeDebug_ (const std::string &text, UInt min_level) const |
| | Writes a string to the log file and to OPENMS_LOG_DEBUG if the debug level is at least min_level.
|
| |
| void | writeDebug_ (const std::string &text, const Param ¶m, UInt min_level) const |
| | Writes a std::string followed by a Param to the log file and to OPENMS_LOG_DEBUG if the debug level is at least min_level.
|
| |
| ExitCodes | runExternalProcess_ (const std::string &executable, const std::vector< std::string > &arguments, const std::string &workdir="", const std::map< std::string, std::string > &env={}) const |
| | Runs an external process via ExternalProcess and prints its stderr output on failure or if debug_level > 4.
|
| |
| ExitCodes | runExternalProcess_ (const std::string &executable, const std::vector< std::string > &arguments, std::string &proc_stdout, std::string &proc_stderr, const std::string &workdir="", const std::map< std::string, std::string > &env={}) const |
| |
| const std::string & | getIniLocation_ () const |
| | Returns the location of the ini file where parameters are taken from. E.g. if the command line was TOPPTool -instance 17, then this will be "TOPPTool:17:". Note the ':' at the end.
|
| |
| const std::string & | toolName_ () const |
| | Returns the tool name.
|
| |
| void | inputFileReadable_ (const std::string &filename, const std::string ¶m_name) const |
| | Checks if an input file exists, is readable and is not empty.
|
| |
| void | outputFileWritable_ (const std::string &filename, const std::string ¶m_name) const |
| | Checks if an output file is writable.
|
| |
| bool | parseRange_ (const std::string &text, double &low, double &high) const |
| | Parses a range string ([a]:[b]) into two variables (doubles)
|
| |
| bool | parseRange_ (const std::string &text, Int &low, Int &high) const |
| | Parses a range string ([a]:[b]) into two variables (integers)
|
| |
| void | addDataProcessing_ (ConsensusMap &map, const DataProcessing &dp) const |
| | Data processing setter for consensus maps.
|
| |
| void | addDataProcessing_ (FeatureMap &map, const DataProcessing &dp) const |
| | Data processing setter for feature maps.
|
| |
| void | addDataProcessing_ (PeakMap &map, const DataProcessing &dp) const |
| | Data processing setter for peak maps.
|
| |
| DataProcessing | getProcessingInfo_ (DataProcessing::ProcessingAction action) const |
| | Returns the data processing information.
|
| |
| DataProcessing | getProcessingInfo_ (const std::set< DataProcessing::ProcessingAction > &actions) const |
| | Returns the data processing information.
|
| |
| template<typename Writer > |
| void | writeToolDescription_ (Writer &writer, std::string write_type, std::string fileExtension) |
| | Helper function avoiding repeated code between CTD, JSON and CWL.
|
| |