ExperimentalDesign

class pyopenms.ExperimentalDesign

Bases: object

Cython implementation of _ExperimentalDesign

Original C++ documentation is available here

Representation of an experimental design in OpenMS. Instances can be loaded with the ExperimentalDesignFile class

__init__()

Overload:

__init__(self) → None

Overload:

__init__(self, in_0: ExperimentalDesign) → None

Methods

__init__	Overload:
fromConsensusMap	__static_ExperimentalDesign_fromConsensusMap(c: ConsensusMap ) -> ExperimentalDesign
fromFeatureMap	__static_ExperimentalDesign_fromFeatureMap(f: FeatureMap ) -> ExperimentalDesign
fromIdentifications	__static_ExperimentalDesign_fromIdentifications(proteins: List[ProteinIdentification] ) -> ExperimentalDesign
getMSFileSection(self)
getNumberOfFractionGroups(self)	Allows to group fraction ids and source files.
getNumberOfFractions(self)	Returns the number of fractions (= highest fraction index)
getNumberOfLabels(self)	Returns the number of labels per file
getNumberOfMSFiles(self)	Returns the number of MS files (= fractions * fraction_groups)
getNumberOfSamples(self)	Returns the number of samples measured (= highest sample index)
getSample(self, fraction_group, label)	Returns sample index (depends on fraction_group and label)
getSampleSection(self)	Returns the Sample Section of the experimental design file
isFractionated(self)	Returns whether at least one fraction_group in this experimental design is fractionated
sameNrOfMSFilesPerFraction(self)	Returns if each fraction number is associated with the same number of fraction_group
setMSFileSection(self, msfile_section)
setSampleSection(self, sample_section)	Sets the Sample Section of the experimental design file

fromConsensusMap()

__static_ExperimentalDesign_fromConsensusMap(c: ConsensusMap ) -> ExperimentalDesign

fromFeatureMap()

__static_ExperimentalDesign_fromFeatureMap(f: FeatureMap ) -> ExperimentalDesign

fromIdentifications()

__static_ExperimentalDesign_fromIdentifications(proteins: List[ProteinIdentification] ) -> ExperimentalDesign

getMSFileSection(self) → List[ExperimentalDesign_MSFileSectionEntry]

getNumberOfFractionGroups(self) → int

Allows to group fraction ids and source files. Return the number of fraction_groups

getNumberOfFractions(self) → int

Returns the number of fractions (= highest fraction index)

getNumberOfLabels(self) → int

Returns the number of labels per file

getNumberOfMSFiles(self) → int

Returns the number of MS files (= fractions * fraction_groups)

getNumberOfSamples(self) → int

Returns the number of samples measured (= highest sample index)

getSample(self, fraction_group: int, label: int) → int

Returns sample index (depends on fraction_group and label)

getSampleSection(self) → ExperimentalDesign_SampleSection

Returns the Sample Section of the experimental design file

isFractionated(self) → bool

Returns whether at least one fraction_group in this experimental design is fractionated

sameNrOfMSFilesPerFraction(self) → bool

Returns if each fraction number is associated with the same number of fraction_group

setMSFileSection(self, msfile_section: List[ExperimentalDesign_MSFileSectionEntry]) → None

setSampleSection(self, sample_section: ExperimentalDesign_SampleSection) → None

Sets the Sample Section of the experimental design file