swagger_client.models.mz_tab module¶

mzTab-M reference implementation and validation API.

This is the mzTab-M reference implementation and validation API service. # noqa: E501

OpenAPI spec version: 2.0.0 Contact: nils.hoffmann@isas.de Generated by: https://github.com/swagger-api/swagger-codegen.git

class swagger_client.models.mz_tab.MzTab(metadata=None, small_molecule_summary=None, small_molecule_feature=None, small_molecule_evidence=None, comment=None)¶

Bases: object

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

MzTab - a model defined in Swagger

attribute_map = {'comment': 'comment', 'metadata': 'metadata', 'small_molecule_evidence': 'smallMoleculeEvidence', 'small_molecule_feature': 'smallMoleculeFeature', 'small_molecule_summary': 'smallMoleculeSummary'}¶

property comment¶

Gets the comment of this MzTab. # noqa: E501

Comment lines can be placed anywhere in an mzTab file. These lines must start with the three-letter code COM and are ignored by most parsers. Empty lines can also occur anywhere in an mzTab file and are ignored. # noqa: E501

Returns: The comment of this MzTab. # noqa: E501
Return type: list[Comment]

property metadata¶

Gets the metadata of this MzTab. # noqa: E501

Returns: The metadata of this MzTab. # noqa: E501
Return type: Metadata

property small_molecule_evidence¶

Gets the small_molecule_evidence of this MzTab. # noqa: E501

The small molecule evidence section is table-based, representing evidence for identifications of small molecules/features, from database search or any other process used to give putative identifications to molecules. In a typical case, each row represents one result from a single search or intepretation of a piece of evidence e.g. a database search with a fragmentation spectrum. Multiple results from a given input data item (e.g. one fragment spectrum) SHOULD share the same value under evidence_input_id. The small molecule evidence section MUST always come after the Small Molecule Feature Table. All table columns MUST be Tab separated. There MUST NOT be any empty cells. Missing values MUST be reported using “null”. The order of columns MUST follow the order specified below. All columns are MANDATORY except for “opt_” columns. # noqa: E501

Returns: The small_molecule_evidence of this MzTab. # noqa: E501
Return type: list[SmallMoleculeEvidence]

property small_molecule_feature¶

Gets the small_molecule_feature of this MzTab. # noqa: E501

The small molecule feature section is table-based, representing individual MS regions (generally considered to be the elution profile for all isotopomers formed from a single charge state of a molecule), that have been measured/quantified. However, for approaches that quantify individual isotopomers e.g. stable isotope labelling/flux studies, then each SMF row SHOULD represent a single isotopomer. Different adducts or derivatives and different charge states of individual molecules should be reported as separate SMF rows. The small molecule feature section MUST always come after the Small Molecule Table. All table columns MUST be Tab separated. There MUST NOT be any empty cells. Missing values MUST be reported using “null”. The order of columns MUST follow the order specified below. All columns are MANDATORY except for “opt_” columns. # noqa: E501

Returns: The small_molecule_feature of this MzTab. # noqa: E501
Return type: list[SmallMoleculeFeature]

property small_molecule_summary¶

Gets the small_molecule_summary of this MzTab. # noqa: E501

The small molecule section is table-based. The small molecule section MUST always come after the metadata section. All table columns MUST be Tab separated. There MUST NOT be any empty cells; missing values MUST be reported using “null” for columns where Is Nullable = “True”. Each row of the small molecule section is intended to report one final result to be communicated in terms of a molecule that has been quantified. In many cases, this may be the molecule of biological interest, although in some cases, the final result could be a derivatized form as appropriate – although it is desirable for the database identifier(s) to reference to the biological (non-derivatized) form. In general, different adduct forms would generally be reported in the Small Molecule Feature section. The order of columns MUST follow the order specified below. All columns are MANDATORY except for “opt_” columns. # noqa: E501

Returns: The small_molecule_summary of this MzTab. # noqa: E501
Return type: list[SmallMoleculeSummary]

swagger_types = {'comment': 'list[Comment]', 'metadata': 'Metadata', 'small_molecule_evidence': 'list[SmallMoleculeEvidence]', 'small_molecule_feature': 'list[SmallMoleculeFeature]', 'small_molecule_summary': 'list[SmallMoleculeSummary]'}¶

to_dict()¶: Returns the model properties as a dict

to_str()¶: Returns the string representation of the model