swagger_client.models.study_variable 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.study_variable.StudyVariable(name=None, assay_refs=None, average_function=None, variation_function=None, description=None, factors=None, **kwargs)¶

Bases: swagger_client.models.indexed_element.IndexedElement

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

Do not edit the class manually.

StudyVariable - a model defined in Swagger

property assay_refs¶

Gets the assay_refs of this StudyVariable. # noqa: E501

The assays referenced by this study variable. # noqa: E501

Returns: The assay_refs of this StudyVariable. # noqa: E501
Return type: list[Assay]

attribute_map = {'assay_refs': 'assay_refs', 'average_function': 'average_function', 'description': 'description', 'factors': 'factors', 'name': 'name', 'variation_function': 'variation_function'}¶

property average_function¶

Gets the average_function of this StudyVariable. # noqa: E501

The function used to calculate summarised small molecule quantities over the assays referenced by this study variable. # noqa: E501

Returns: The average_function of this StudyVariable. # noqa: E501
Return type: Parameter

property description¶

Gets the description of this StudyVariable. # noqa: E501

A free-form description of this study variable. # noqa: E501

Returns: The description of this StudyVariable. # noqa: E501
Return type: str

property factors¶

Gets the factors of this StudyVariable. # noqa: E501

Parameters indicating which factors were used for the assays referenced by this study variable, and at which levels. # noqa: E501

Returns: The factors of this StudyVariable. # noqa: E501
Return type: list[Parameter]

property name¶

Gets the name of this StudyVariable. # noqa: E501

The study variable name. # noqa: E501

Returns: The name of this StudyVariable. # noqa: E501
Return type: str

swagger_types = {'assay_refs': 'list[Assay]', 'average_function': 'Parameter', 'description': 'str', 'factors': 'list[Parameter]', 'name': 'str', 'variation_function': 'Parameter'}¶

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

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

property variation_function¶

Gets the variation_function of this StudyVariable. # noqa: E501

The function used to calculate the variation of small molecule quantities over the assays referenced by this study variable. # noqa: E501

Returns: The variation_function of this StudyVariable. # noqa: E501
Return type: Parameter