Leeds-MRG / Minos

SIPHER Microsimulation for estimating the effect on Income policy on mental health.
MIT License
3 stars 2 forks source link

Help text in model_definition_{X}.txt files #386

Open ld-archer opened 4 months ago

ld-archer commented 4 months ago

We now have quite a lot of transition model types to choose from, some that have specific requirements (such as the random effects term in mixed effects models), and some other specific quirks (e.g. RandomForest model can't have modifiers like scale() or factor() in the formula). A big help comment might be useful for us and anyone else who tries to add a new model.

Requirements:

Not thinking this can replace proper documentation, but wouldn't take long and could be useful.

ld-archer commented 4 months ago

Maybe better as a README.txt in the transitions directory as there are multiple model_definitions_X files.