omnipy.components.isa.models.factor_value_schema

ISA model representing a factor value in an investigation.

ISA means Investigation/Study/Assay, and these classes model ISA-JSON JSON-LD payloads.

Returned by:

• Reference Code reference omnipy components
  •  isa
    •  IsaSampleSchema  factorValues
    •  IsaStudyGroupSchema  factor_levels
  • isa models
    •  sample_schema  IsaSampleSchema  factorValues
    •  study_group  IsaStudyGroupSchema  factor_levels

CLASS	DESCRIPTION
FieldType	JSON-LD type labels used for ISA factor-value entities.
IsaFactorValueModel	Omnipy model wrapper for ISA factor-value assignments.
IsaFactorValueSchema	Schema for values assigned to study factors.

FieldType

Bases: Enum

              flowchart BT
              omnipy.components.isa.models.factor_value_schema.FieldType[FieldType]

              

              click omnipy.components.isa.models.factor_value_schema.FieldType href "" "omnipy.components.isa.models.factor_value_schema.FieldType"
            

JSON-LD type labels used for ISA factor-value entities.

ATTRIBUTE	DESCRIPTION
FactorValue	Marks a JSON object as an ISA factor assignment value.

Returned by:

• Reference Code reference omnipy components
  •  isa  IsaFactorValueSchema  field_type
  • isa models  factor_value_schema  IsaFactorValueSchema  field_type

Source code in src/omnipy/components/isa/models/factor_value_schema.py

class FieldType(Enum):
    """JSON-LD type labels used for ISA factor-value entities.

    Attributes:
        FactorValue: Marks a JSON object as an ISA factor assignment value.
    """

    FactorValue = 'FactorValue'

FactorValue class-attribute instance-attribute

FactorValue = 'FactorValue'

IsaFactorValueModel

Bases: Model[IsaFactorValueSchema]

              flowchart BT
              omnipy.components.isa.models.factor_value_schema.IsaFactorValueModel[IsaFactorValueModel]
              omnipy.data.model.Model[Model]
              omnipy.data._mixins.display.ModelDisplayMixin[ModelDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.model.Model --> omnipy.components.isa.models.factor_value_schema.IsaFactorValueModel
                                omnipy.data._mixins.display.ModelDisplayMixin --> omnipy.data.model.Model
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.ModelDisplayMixin
                

                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.model.Model
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.model.Model
                



              click omnipy.components.isa.models.factor_value_schema.IsaFactorValueModel href "" "omnipy.components.isa.models.factor_value_schema.IsaFactorValueModel"
              click omnipy.data.model.Model href "" "omnipy.data.model.Model"
              click omnipy.data._mixins.display.ModelDisplayMixin href "" "omnipy.data._mixins.display.ModelDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Omnipy model wrapper for ISA factor-value assignments.

Provides Omnipy model behavior around values validated by :class:IsaFactorValueSchema.

Returned by:

• Reference Code reference omnipy components
  •  isa
    •  IsaSampleSchema  factorValues
    •  IsaStudyGroupSchema  factor_levels
  • isa models
    •  sample_schema  IsaSampleSchema  factorValues
    •  study_group  IsaStudyGroupSchema  factor_levels

Source code in src/omnipy/components/isa/models/factor_value_schema.py

class IsaFactorValueModel(Model[IsaFactorValueSchema]):
    """Omnipy model wrapper for ISA factor-value assignments.

    Provides Omnipy model behavior around values validated by
    :class:`IsaFactorValueSchema`.
    """

    ...

IsaFactorValueSchema

Bases: pyd.BaseModel

              flowchart BT
              omnipy.components.isa.models.factor_value_schema.IsaFactorValueSchema[IsaFactorValueSchema]

                              omnipy.util.pydantic.BaseModel --> omnipy.components.isa.models.factor_value_schema.IsaFactorValueSchema
                


              click omnipy.components.isa.models.factor_value_schema.IsaFactorValueSchema href "" "omnipy.components.isa.models.factor_value_schema.IsaFactorValueSchema"
            

Schema for values assigned to study factors.

ATTRIBUTE	DESCRIPTION
category	Factor definition that this value belongs to. TYPE: factor_schema.IsaFactorModel | None
value	Actual assigned value, either ontology-backed or scalar. TYPE: ontology_annotation_schema.IsaOntologyReferenceModel | str | float | None
unit	Unit ontology term for numeric values when applicable. TYPE: ontology_annotation_schema.IsaOntologyReferenceModel | None
comments	Optional comments describing the assignment. TYPE: list[comment_schema.IsaCommentModel] | None

Subclassed by:

• Reference Code reference
  •  omnipy  IsaFactorValueModel
  • omnipy components isa models  factor_value_schema  IsaFactorValueModel

CLASS	DESCRIPTION
Config	Validation settings for ISA factor-value schema parsing.

Source code in src/omnipy/components/isa/models/factor_value_schema.py

class IsaFactorValueSchema(pyd.BaseModel):
    """Schema for values assigned to study factors.

    Attributes:
        category: Factor definition that this value belongs to.
        value: Actual assigned value, either ontology-backed or scalar.
        unit: Unit ontology term for numeric values when applicable.
        comments: Optional comments describing the assignment.
    """
    class Config:
        """Validation settings for ISA factor-value schema parsing.

        Attributes:
            extra: Rejects keys not declared in the schema.
            use_enum_values: Converts enum members to raw value strings.
        """

        extra = pyd.Extra.forbid
        use_enum_values = True

    field_id: Optional[str] = pyd.Field(None, alias='@id')
    field_context: Optional[str] = pyd.Field(None, alias='@context')
    field_type: Optional[FieldType] = pyd.Field(None, alias='@type')
    category: Optional[factor_schema.IsaFactorModel] = None
    value: Optional[Union[ontology_annotation_schema.IsaOntologyReferenceModel, str, float]] = None
    unit: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

category class-attribute instance-attribute

category: factor_schema.IsaFactorModel | None = None

comments class-attribute instance-attribute

comments: list[comment_schema.IsaCommentModel] | None = None

field_context class-attribute instance-attribute

field_context: str | None = pyd.Field(None, alias='@context')

field_id class-attribute instance-attribute

field_id: str | None = pyd.Field(None, alias='@id')

field_type class-attribute instance-attribute

field_type: FieldType | None = pyd.Field(None, alias='@type')

unit class-attribute instance-attribute

unit: ontology_annotation_schema.IsaOntologyReferenceModel | None = None

value class-attribute instance-attribute

value: ontology_annotation_schema.IsaOntologyReferenceModel | str | float | None = None

Config

Validation settings for ISA factor-value schema parsing.

ATTRIBUTE	DESCRIPTION
extra	Rejects keys not declared in the schema.
use_enum_values	Converts enum members to raw value strings.

Source code in src/omnipy/components/isa/models/factor_value_schema.py

class Config:
    """Validation settings for ISA factor-value schema parsing.

    Attributes:
        extra: Rejects keys not declared in the schema.
        use_enum_values: Converts enum members to raw value strings.
    """

    extra = pyd.Extra.forbid
    use_enum_values = True

extra class-attribute instance-attribute

extra = pyd.Extra.forbid

use_enum_values class-attribute instance-attribute

use_enum_values = True