search

mrc-ide / frogger

https://mrc-ide.github.io/frogger/
Other
0 stars 1 forks source link

more descriptive filename for model_simulation.hpp #85

Open jeffeaton opened 3 months ago

jeffeaton commented 3 months ago

In the code file names in inst/include/, several of the names are very helpfully names to know what is in them: https://github.com/mrc-ide/frogger/tree/main/inst/include

general_demographic_projection.hpp hiv_demographic_projection.hpp etc.

model_simulation.hpp, which contains all of the key HIV model simulation bits, has a quite nondescript name, and I had to search around a bit to find what had theART initiation.

What about renaming this something like hiv_model_simulation.hpp?

r-ash commented 2 months ago

adult_hiv_model_simulation.hpp, and make the child one child_hiv_model_simulation.hpp

Add a README into the inst folder to make it clear generated code should be not touched, and point to where the model code is.