ExperimentalDesign::MSFileSectionEntry Class Reference

One row of the MS file section: one quantitative channel of one MS file. More...

#include <OpenMS/METADATA/ExperimentalDesign.h>

Public Member Functions
	MSFileSectionEntry ()=default

Public Attributes
unsigned	fraction_group = 1
	Fraction group id: the rows combined into one quantity.
unsigned	fraction = 1
	Fraction 1..m, mandatory, 1 if not set.
std::string	path = "UNKNOWN_FILE"
	File name, mandatory.
unsigned	label = 1
	1-based channel position within path (1 for label-free)
unsigned	sample = 0
	Zero-based ROW INDEX into the sample section; allows grouping by sample.
std::string	sample_name = "0"
	The Sample column value, i.e. the sample's NAME.

Detailed Description

One row of the MS file section: one quantitative channel of one MS file.

This is the in-memory form of a row of the design table described on ExperimentalDesign. It links a single quantitative value back to the file it came from and supports:

• multiplexed/labeled data via specification of the quantified label
• multiple fractions via specification of the:
  • fraction index (e.g., 1..10 if ten fractions were measured)
  • fraction_group to trace which fractions belong together

Constructor & Destructor Documentation

MSFileSectionEntry()

MSFileSectionEntry ( )

default

Member Data Documentation

fraction

unsigned fraction = 1

Fraction 1..m, mandatory, 1 if not set.

1 everywhere for unfractionated data. The same number in two fraction groups denotes corresponding fractions.

fraction_group

unsigned fraction_group = 1

Fraction group id: the rows combined into one quantity.

1-based and consecutive over the whole design. A second measurement of the same material is a new group carrying the same sample.

label

unsigned label = 1

1-based channel position within path (1 for label-free)

E.g. 1..10 for TMT10plex in canonical channel order 126, 127N, ..., 131. A position, not a reagent name.

path

std::string path = "UNKNOWN_FILE"

File name, mandatory.

sample

unsigned sample = 0

Zero-based ROW INDEX into the sample section; allows grouping by sample.

This is not the Sample column value – that is sample_name.

sample_name

std::string sample_name = "0"

The Sample column value, i.e. the sample's NAME.

An arbitrary string such as "1" or "BSA1", used to look the sample row up by name rather than by index.