Heredograma

Sobre heredogramas

Um heredograma é um diagrama padronizado usado em genética clínica para rastrear uma única condição — ou um pequeno conjunto de condições relacionadas — em uma família ao longo de várias gerações. Ao contrário de um genograma, que registra textura emocional e social, um heredograma é puramente estrutural: quem é afetado, quem é portador, quem foi testado e quem é o caso índice. Conselheiros genéticos, geneticistas clínicos e médicos encaminhadores o usam para avaliar o padrão de herança, o risco de recorrência e quem mais na família deveria ser submetido a testes.

O Schematex segue as recomendações Bennett et al. (2022) da NSGC — a atualização mais recente da Sociedade Nacional de Conselheiros Genéticos — que substitui as revisões de 1995 e 2008. Para informações básicas, consulte Wikipedia: Pedigree chart. Esta página documenta o que o parser aceita atualmente.

1. Seu primeiro heredograma

O menor heredograma clinicamente útil: dois pais e seu filho afetado.

Quatro regras cobrem 80% dos casos:

1. Comece com a palavra-chave pedigree, opcionalmente seguida de um título entre aspas.
2. Declare cada indivíduo em sua própria linha: id [atributos]. Convencionalmente os IDs são I-1, II-3, etc. — geração em algarismo romano, traço, posição dentro da geração.
3. Conecte dois indivíduos com um operador de casal — -- (união), == (consanguíneo), -/- (separado), ~ (sem descendência). Consulte o §4.
4. Indente abaixo da linha de casal para adicionar seus filhos. Qualquer recuo mais profundo funciona; dois espaços é convencional.

Os comentários devem estar em sua própria linha, começando com #, // ou no estilo Mermaid %%. Comentários inline no final da linha vão quebrar o parser.

2. Indivíduos

Uma linha de indivíduo é id [attr1, attr2, …]. Os atributos são separados por vírgula, independentes de ordem, todos opcionais.

Regras de ID. Deve corresponder a [a-zA-Z][a-zA-Z0-9_-]*. Os IDs não diferenciam maiúsculas/minúsculas internamente, mas preservam sua capitalização original como rótulo de exibição (substitua com label:"…").

Atributos aceitos pelo parser hoje:

3. Formas, status, marcadores

3.1 Formas (Bennett 2022)

Bennett 2022 formalizou que quadrado e círculo representam o sexo atribuído ao nascimento, não a identidade de gênero. Se a identidade de gênero difere, registre-a no rótulo ([female, label: "Homem trans (AFAB)"]) — não altere a forma.

3.2 Status genético (preenchimento)

3.3 Marcadores

3.4 Status de vida

Múltiplos tokens se combinam: [female, affected, deceased], [male, sab], [unknown, pregnancy, presymptomatic].

4. Casais e filhos

4.1 Operadores de casal

O parser tenta estes na ordem. A primeira correspondência vence — então -/- vence --.

4.2 Indivíduo inline no lado direito

Se o indivíduo do lado direito ainda não foi declarado, declare-o no lugar:

4.3 Filhos (indentados abaixo de um casal)

Indentação abaixo de uma linha de casal = "estes são os filhos deste casal." Qualquer indentação maior que a do casal funciona; dois espaços é convencional.

4.4 Uniões consanguíneas

A consanguinidade é renderizada como uma linha dupla e deve ser tornada visível — é a peça de informação mais importante de muitos heredogramas.

5. Heredogramas de múltiplos traços

Para famílias que carregam mais de uma condição hereditária, use linhas legend: para definir qual quadrante da forma representa qual traço, depois marque os indivíduos com affected: trait1+trait2.

pedigree "Cancer Family Syndrome"
  legend: breast = "Breast cancer" (fill: quad-tl)
  legend: ovarian = "Ovarian cancer" (fill: quad-tr)
  legend: prostate = "Prostate cancer" (fill: quad-bl)
  legend: colon = "Colon cancer" (fill: quad-br)

  I-1 [male, affected: prostate, deceased]
  I-2 [female, affected: breast, deceased]
  I-1 -- I-2
    II-1 [female, affected: breast+ovarian]
    II-2 [male, unaffected]

Sintaxe de legenda: legend: id = "Rótulo legível" (fill: POSIÇÃO).

Os indivíduos usam os IDs de traço da legenda: [affected: breast], [affected: breast+ovarian]. O + junta os traços; os quadrantes se preenchem cumulativamente.

6. Rótulos e comentários

• Título: pedigree "BRCA1 Family" — somente na primeira linha.
• Substituição de rótulo individual: II-1 [female, affected, label: "Jane Smith (42)"].
• Entrada de legenda: legend: id = "Rótulo" (fill: POSIÇÃO) — veja §5.
• Sufixo de modo: pedigree:autosomal-dominant "Família X" é aceito. O sufixo é armazenado como metadata.mode; os renderizadores atuais o ignoram.
• Comentários: #, // ou %% no início de uma linha (após espaço em branco inicial). Comentários inline no final da linha não são suportados.

7. Palavras reservadas e escape

Reservadas no início da linha: pedigree (cabeçalho), legend: (entrada de legenda).

Tokens de operador reservados dentro de uma linha — evite usar estas sequências em IDs: --, ==, -/-, ~.

Tokens de atributo reservados dentro de […] — o parser irá interpretá-los independentemente da posição: tokens de sexo (male, female, unknown, amab, afab, uaab), status genéticos (affected, carrier, carrier-x, obligate-carrier, presymptomatic, unaffected), marcadores (proband, consultand, evaluated) e status de vida (deceased, stillborn, pregnancy, sab, tab, ectopic).

Strings com espaços devem ser entre aspas duplas. Aspas simples e crases não são reconhecidas.

8. Erros comuns

Erros reais do parser, o que os aciona e como corrigi-los.

9. Gramática (EBNF)

document       = header (blank | comment | legend | individual | couple-block)*

header         = "pedigree" ( ":" mode )? ( WS quoted-string )? NEWLINE
mode           = [A-Za-z] [A-Za-z0-9_-]*
quoted-string  = '"' any-char-but-quote* '"'

legend         = INDENT "legend:" WS id WS "=" WS quoted-string
                   ( WS "(" "fill:" fill-value ")" )? NEWLINE

individual     = INDENT id ( "[" attrs "]" )? NEWLINE
couple-block   = INDENT id WS coupleOp WS right-side NEWLINE
                   ( deeper-indent child )*
child          = INDENT id ( "[" attrs "]" )? NEWLINE
right-side     = id ( "[" attrs "]" )?

coupleOp       = "-/-" | "==" | "--" | "~"

id             = [a-zA-Z] [a-zA-Z0-9_-]*
attrs          = attr ("," attr)*
attr           = sex
               | genetic-status
               | marker
               | life-status
               | digit digit digit digit                         // ano de nascimento
               | "label" ":" quoted-string
               | "affected" ":" trait-id ( "+" trait-id )*
               | key ":" value                                    // personalizado

sex            = "male" | "female" | "unknown" | "amab" | "afab" | "uaab"
genetic-status = "unaffected" | "affected" | "carrier" | "carrier-x"
               | "obligate-carrier" | "presymptomatic"
marker         = "proband" | "consultand" | "evaluated"
life-status    = "deceased" | "stillborn" | "pregnancy"
               | "sab" | "tab" | "ectopic"
fill-value     = "full" | "half-left" | "half-right" | "half-top" | "half-bottom"
               | "quad-tl" | "quad-tr" | "quad-bl" | "quad-br"

comment        = INDENT ( "#" | "//" | "%%" ) any NEWLINE

Fonte autoritativa: src/diagrams/pedigree/parser.ts. Se houver divergência com o parser, o parser prevalece — por favor, abra uma issue.

10. Conformidade com padrões

Os heredogramas do Schematex seguem Bennett, R.L. et al. (2022), The evolving pedigree: Updating to reflect modern family structures, sex, and gender para semântica de formas, preenchimentos de status e as convenções de proband/consultand. Revisões anteriores (Bennett 1995, 2008) permanecem uma referência válida para o subconjunto clássico.

O que está implementado hoje em relação ao padrão:

• ✅ Formas principais (quadrado / círculo / diamante) com semântica AMAB/AFAB/UAAB do Bennett 2022
• ✅ Conjunto completo de status genético (affected / carrier / carrier-x / obligate-carrier / presymptomatic / unaffected)
• ✅ Marcadores proband, consultand, evaluated
• ✅ Modificadores de status de vida (deceased, stillborn, pregnancy, SAB, TAB, ectopic)
• ✅ Operadores de casal: unido / separado / consanguíneo / sem descendência
• ✅ Preenchimentos de quadrante para múltiplos traços com entradas legend:
• ⏳ Notação de gêmeos (monozigótico / dizigótico / zigosidade desconhecida)
• ⏳ Notação de colchete para adoção (adotado para dentro / adotado para fora)
• ⏳ Reprodução assistida (doação de óvulo/esperma/embrião, barriga de aluguel, FIV)
• ⏳ Marcadores de sem filhos por escolha e infertilidade

Referências:

• Bennett, R.L., French, K.S., Resta, R.G., & Austin, J. (2022). Practice resource-focused revision: Standardized pedigree nomenclature update centered on sex and gender inclusivity. Journal of Genetic Counseling, 31(6), 1238–1249.
• Bennett, R.L., Steinhaus French, K., Resta, R.G., & Doyle, D.L. (2008). Standardized human pedigree nomenclature: Update and assessment. J Genet Couns, 17(5), 424–433.
• Bennett, R.L. et al. (1995). Recommendations for standardized human pedigree nomenclature. Am J Hum Genet, 56(3), 745–752.

11. Exemplos relacionados

Cenários prontos para uso da galeria de exemplos:

12. Roadmap

Planejado — ainda não analisável pelo parser. Não use estes itens em DSL gerada hoje; o parser irá rejeitá-los ou armazená-los como propriedades personalizadas não utilizadas.

• Notação de gêmeos — twin-mz (monozigótico), twin-dz (dizigótico), twin-unknown.
• Colchetes de adoção — adopted-in, adopted-out (forma entre colchetes, linha tracejada para pais biológicos).
• Reprodução assistida — donor-egg, donor-sperm, donor-embryo, surrogate e uma anotação ivf na linha do casal.
• Marcadores de sem filhos — anotações de linha suspensa no-children (por escolha) e infertile.
• Anotação de identidade de gênero — um atributo estruturado distinto do sexo, em vez de colocá-lo em label:.
• Trigêmeos e partos de ordem superior — triplet-mz, triplet-dz.

Acompanhe nas issues do GitHub se você precisar de algum desses recursos mais cedo.