OpenMS
Static Public Member Functions | Static Private Member Functions | List of all members
ExperimentalDesignFile Class Reference
Format

Load an experimental design from a TSV file. (see ExperimentalDesign for details on the supported format) More...

#include <OpenMS/FORMAT/ExperimentalDesignFile.h>

Static Public Member Functions

static ExperimentalDesign load (const String &tsv_file, bool require_spectra_files)
 Loads an experimental design from a tabular separated file. More...
 
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. More...
 

Static Private Member Functions

static bool isOneTableFile_ (const TextFile &text_file)
 
static ExperimentalDesign parseOneTableFile_ (const TextFile &text_file, const String &tsv_file, bool require_spectra_file)
 
static ExperimentalDesign parseTwoTableFile_ (const TextFile &text_file, const String &tsv_file, bool require_spectra_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)
 

Detailed Description

Load an experimental design from a TSV file. (see ExperimentalDesign for details on the supported format)

Member Function Documentation

◆ isOneTableFile_()

static bool isOneTableFile_ ( const TextFile &  text_file)
staticprivate

◆ load() [1/2]

static ExperimentalDesign load ( const String &  tsv_file,
bool  require_spectra_files 
)
static

Loads an experimental design from a tabular separated file.

◆ load() [2/2]

static ExperimentalDesign load ( const TextFile &  text_file,
const bool  require_spectra_file,
String  filename 
)
static

Loads an experimental design from an already loaded or generated, tabular file.

◆ parseErrorIf_()

static void parseErrorIf_ ( const bool  test,
const String &  filename,
const String &  message 
)
staticprivate

◆ parseHeader_()

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 
)
staticprivate

Reads header line of File and Sample section, checks for the existence of required headers and maps the column name to its position

◆ parseOneTableFile_()

static ExperimentalDesign parseOneTableFile_ ( const TextFile &  text_file,
const String &  tsv_file,
bool  require_spectra_file 
)
staticprivate

◆ parseTwoTableFile_()

static ExperimentalDesign parseTwoTableFile_ ( const TextFile &  text_file,
const String &  tsv_file,
bool  require_spectra_file 
)
staticprivate