> For the complete documentation index, see [llms.txt](https://clinical-genomics.gitbook.io/project-mip/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://clinical-genomics.gitbook.io/project-mip/develop/documentation/api/pedigree.md).

# Pedigree

**Version: 1.0.0**

The metadata on the case is recorded in a yaml file format with the following data structure and keys:

```
case: string,
samples: [  # Array of hashes
  - { # Sample specific info hash
      analysis_type: string, value="wes | wgs | wts"
      capture_kit: string, 
      expected_coverage: Integer,
      father: string, value="<case_id> | 0"
      mother: string, value="<case_id> | 0"
      phenotype: string, value="affected | unaffected | unknown"
      sample_id: string,
      sample_display_name: string,
      is_from_sample: string, value="<sample_id>""
      sex: string, value="male | female | other"
      time_point: Integer,
    }
  - {
      analysis_type: string, value="wes | wgs | wts"
    .,
    .,
    }
],
```