OpenMS
Loading...
Searching...
No Matches
ExperimentalDesignFile.h
Go to the documentation of this file.
1// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
2// SPDX-License-Identifier: BSD-3-Clause
3//
4// --------------------------------------------------------------------------
5// $Maintainer: Timo Sachsenberg $
6// $Authors: Timo Sachsenberg, Lukas Zimmermann $
7// --------------------------------------------------------------------------
8
9#pragma once
10
13
14#include <map>
15#include <set>
16
17namespace OpenMS
18{
19 class ExperimentalDesign;
20 class TextFile;
45 class OPENMS_DLLAPI ExperimentalDesignFile
46 {
47 public:
48
70 static ExperimentalDesign load(const std::string& tsv_file, bool require_spectra_files);
71
79 static ExperimentalDesign load(const TextFile& text_file, const bool require_spectra_file, std::string filename);
80
81 private:
82 static bool isOneTableFile_(const TextFile& text_file);
83 static ExperimentalDesign parseOneTableFile_(const TextFile& text_file, const std::string& tsv_file, bool require_spectra_file);
84 static ExperimentalDesign parseTwoTableFile_(const TextFile& text_file, const std::string& tsv_file, bool require_spectra_file);
87 static void parseHeader_(
88 const StringList &header,
89 const std::string &filename,
90 std::map <std::string, Size> &column_map,
91 const std::set <std::string> &required,
92 const std::set <std::string> &optional,
93 bool allow_other_header);
94
96 static void parseErrorIf_(const bool test, const std::string &filename, const std::string &message);
97 };
98}
99
Load an experimental design from a TSV file.
Definition ExperimentalDesignFile.h:46
static ExperimentalDesign parseTwoTableFile_(const TextFile &text_file, const std::string &tsv_file, bool require_spectra_file)
static ExperimentalDesign load(const std::string &tsv_file, bool require_spectra_files)
Loads an experimental design from a tabular separated file.
static ExperimentalDesign parseOneTableFile_(const TextFile &text_file, const std::string &tsv_file, bool require_spectra_file)
static void parseErrorIf_(const bool test, const std::string &filename, const std::string &message)
Throws Exception::ParseError with filename and message if test is true.
static void parseHeader_(const StringList &header, const std::string &filename, std::map< std::string, Size > &column_map, const std::set< std::string > &required, const std::set< std::string > &optional, bool allow_other_header)
static bool isOneTableFile_(const TextFile &text_file)
static ExperimentalDesign load(const TextFile &text_file, const bool require_spectra_file, std::string filename)
Loads an experimental design from an already loaded or generated, tabular file.
Representation of an experimental design in OpenMS. Instances can be loaded with the ExperimentalDesi...
Definition ExperimentalDesign.h:449
Definition TextFile.h:21
std::vector< std::string > StringList
Vector of String.
Definition TypeAliases.h:39
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19