tracts.driver_utils.SamplesConfig#
- class SamplesConfig(**data)#
Bases:
BaseModelConfiguration for the samples used in the inference. This includes information about the directory where the sample files are located, the names of the individuals and populations, and the format of the filenames. The configuration also specifies which chromosomes to include in the analysis and any allosomes to consider.
- directory#
The directory where the sample files are located.
- Type:
str
- individual_names#
A list of individual names corresponding to the sample files.
- Type:
List[str]
- male_names#
A list of individual names corresponding to male individuals, or None to automatically determine based on the presence of allosomes.
- Type:
List[str] | None
- filename_format#
The format of the sample filenames, which should include placeholders for the individual name and chromosome (e.g. “{individual}_{chromosome}.txt”).
- Type:
str
- labels#
A list of population labels corresponding to the sample files. Defaults to [“A”, “B”].
- Type:
List[str]
- chromosomes#
A string specifying which chromosomes to include in the analysis.
- Type:
str
- allosomes#
A list of allosome chromosome names. Currenly only supporting “X”.
- Type:
List[str]
- model_config: ClassVar[ConfigDict] = {'extra': 'forbid'}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].