omnipy.components.isa.models.study_group

ISA model representing a study group in an investigation.

ISA-JSON expresses Investigation/Study/Assay metadata using JSON-LD fields that these classes validate.

CLASS	DESCRIPTION
FieldType	JSON-LD type labels used for ISA study-group entities.
IsaStudyGroupModel	Omnipy model wrapper for ISA study-group records.
IsaStudyGroupSchema	Schema for study groups used to organize related samples.

FieldType

Bases: Enum

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

              

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

JSON-LD type labels used for ISA study-group entities.

ATTRIBUTE	DESCRIPTION
Study_Group	Marks a JSON object as an ISA study group.

Returned by:

• Reference Code reference omnipy components
  •  isa  IsaStudyGroupSchema  field_type
  • isa models  study_group  IsaStudyGroupSchema  field_type

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

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

    Attributes:
        Study_Group: Marks a JSON object as an ISA study group.
    """

    Study_Group = 'Study Group'

Study_Group class-attribute instance-attribute

Study_Group = 'Study Group'

IsaStudyGroupModel

Bases: Model[IsaStudyGroupSchema]

              flowchart BT
              omnipy.components.isa.models.study_group.IsaStudyGroupModel[IsaStudyGroupModel]
              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.study_group.IsaStudyGroupModel
                                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.study_group.IsaStudyGroupModel href "" "omnipy.components.isa.models.study_group.IsaStudyGroupModel"
              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 study-group records.

Wraps :class:IsaStudyGroupSchema for validated use in Omnipy ISA datasets and related metadata structures.

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

class IsaStudyGroupModel(Model[IsaStudyGroupSchema]):
    """Omnipy model wrapper for ISA study-group records.

    Wraps :class:`IsaStudyGroupSchema` for validated use in Omnipy ISA
    datasets and related metadata structures.
    """

    ...

IsaStudyGroupSchema

Bases: pyd.BaseModel

              flowchart BT
              omnipy.components.isa.models.study_group.IsaStudyGroupSchema[IsaStudyGroupSchema]

                              omnipy.util.pydantic.BaseModel --> omnipy.components.isa.models.study_group.IsaStudyGroupSchema
                


              click omnipy.components.isa.models.study_group.IsaStudyGroupSchema href "" "omnipy.components.isa.models.study_group.IsaStudyGroupSchema"
            

Schema for study groups used to organize related samples.

ATTRIBUTE	DESCRIPTION
name	Study group label. TYPE: str | None
factor_levels	Factor-value assignments that define the group. TYPE: list[factor_value_schema.IsaFactorValueModel] | None
study_group_size	Number of members in the group. TYPE: int | None
members	Sample entries assigned to the group. TYPE: list[sample_schema.IsaSampleModel] | None

Subclassed by:

• Reference Code reference
  •  omnipy  IsaStudyGroupModel
  • omnipy components isa models  study_group  IsaStudyGroupModel

CLASS	DESCRIPTION
Config	Validation settings for ISA study-group schema parsing.

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

class IsaStudyGroupSchema(pyd.BaseModel):
    """Schema for study groups used to organize related samples.

    Attributes:
        name: Study group label.
        factor_levels: Factor-value assignments that define the group.
        study_group_size: Number of members in the group.
        members: Sample entries assigned to the group.
    """
    class Config:
        """Validation settings for ISA study-group schema parsing.

        Attributes:
            extra: Rejects keys not declared by the schema.
            use_enum_values: Converts enum members to 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')
    name: Optional[str] = None
    factor_levels: Optional[List[factor_value_schema.IsaFactorValueModel]] = None
    study_group_size: Optional[int] = None
    members: Optional[List[sample_schema.IsaSampleModel]] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

comments class-attribute instance-attribute

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

factor_levels class-attribute instance-attribute

factor_levels: list[factor_value_schema.IsaFactorValueModel] | 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')

members class-attribute instance-attribute

members: list[sample_schema.IsaSampleModel] | None = None

name class-attribute instance-attribute

name: str | None = None

study_group_size class-attribute instance-attribute

study_group_size: int | None = None

Config

Validation settings for ISA study-group schema parsing.

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

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

class Config:
    """Validation settings for ISA study-group schema parsing.

    Attributes:
        extra: Rejects keys not declared by the schema.
        use_enum_values: Converts enum members to 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