bio-learn/biolearn

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

Aperta

#200 aperta il 25 mar 2026

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (35 fork)auto 404
good first issue

Metriche repository

Star
 (87 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina il generatore di documentazione corrente in doc/generate.py per capire come accede alle informazioni del modello. Identifica come istanziare i modelli o estrarre staticamente i siti di metilazione per i modelli privi di un file di coefficienti. Implementa il codice per chiamare methylation sites() sull'oggetto modello e popolare la colonna dei coefficienti nella documentazione.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Python
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50