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;
27 class OPENMS_DLLAPI ExperimentalDesignFile
28 {
29 public:
30
32 static ExperimentalDesign load(const String& tsv_file, bool require_spectra_files);
33
35 static ExperimentalDesign load(const TextFile& text_file, const bool require_spectra_file, String filename);
36
37 private:
38 static bool isOneTableFile_(const TextFile& text_file);
39 static ExperimentalDesign parseOneTableFile_(const TextFile& text_file, const String& tsv_file, bool require_spectra_file);
40 static ExperimentalDesign parseTwoTableFile_(const TextFile& text_file, const String& tsv_file, bool require_spectra_file);
43 static void parseHeader_(
44 const StringList &header,
45 const String &filename,
46 std::map <String, Size> &column_map,
47 const std::set <String> &required,
48 const std::set <String> &optional,
49 bool allow_other_header);
50
52 static void parseErrorIf_(const bool test, const String &filename, const String &message);
53 };
54}
55
Load an experimental design from a TSV file. (see ExperimentalDesign for details on the supported for...
Definition ExperimentalDesignFile.h:28
static ExperimentalDesign load(const String &tsv_file, bool require_spectra_files)
Loads an experimental design from a tabular separated file.
static ExperimentalDesign load(const TextFile &text_file, const bool require_spectra_file, String filename)
Loads an experimental design from an already loaded or generated, tabular file.
static void parseHeader_(const StringList &header, const String &filename, std::map< String, Size > &column_map, const std::set< String > &required, const std::set< String > &optional, bool allow_other_header)
static void parseErrorIf_(const bool test, const String &filename, const String &message)
static ExperimentalDesign parseTwoTableFile_(const TextFile &text_file, const String &tsv_file, bool require_spectra_file)
static bool isOneTableFile_(const TextFile &text_file)
static ExperimentalDesign parseOneTableFile_(const TextFile &text_file, const String &tsv_file, bool require_spectra_file)
Representation of an experimental design in OpenMS. Instances can be loaded with the ExperimentalDesi...
Definition ExperimentalDesign.h:109
A more convenient string class.
Definition String.h:34
Definition TextFile.h:21
std::vector< String > StringList
Vector of String.
Definition ListUtils.h:44
Main OpenMS namespace.
Definition openswathalgo/include/OpenMS/OPENSWATHALGO/DATAACCESS/ISpectrumAccess.h:19