bio-learn/biolearn

enhancement: surface required CpG sites in docs for models without a coefficients file

Aberta

#200 aberto em 25 de mar. de 2026

Ver no GitHub
 (0 comentário) (0 reação) (0 responsável)Python (35 forks)auto 404
good first issue

Métricas do repositório

Stars
 (87 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Models like HurdleInflammAge don't have a model.file entry but do expose their required sites via methylation_sites(). The doc generator currently shows "N/A" for these models.

A future improvement could instantiate the model (or extract sites statically) to populate the coefficients column. This would require reworking how doc/generate.py accesses model info since it currently only reads static definition dicts, not instantiated objects.

Ref: https://github.com/bio-learn/biolearn/pull/197#pullrequestreview-2710853685

Guia do colaborador

Direção de pesquisa
Examine o gerador de documentação atual em doc/generate.py para entender como ele acessa as informações do modelo. Identifique como instanciar modelos ou extrair estaticamente os sítios de metilação para modelos sem um arquivo de coeficientes. Implemente código para chamar methylation sites() no objeto modelo e preencher a coluna de coeficientes na documentação.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Python
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50