rmnldwg / lymph

Python package for statistical modelling of lymphatic metastatic spread in head & neck cancer.
https://lymph-model.readthedocs.io
MIT License
5 stars 4 forks source link

parameter assignment "not elegant" #86

Closed YoelPH closed 2 weeks ago

YoelPH commented 2 weeks ago

I just started exploring the newest version of the code. I noticed the following thing:

After setting up a model and running the get_params function, I get the following output:

model.get_params(as_dict=True)
----------------------------------------------------------------
{'primarytoII_spread': 0.0,
 'primarytoIII_spread': 0.0,
 'primarytoIV_spread': 0.0,
 'IItoIII_spread': 0.0,
 'IIItoIV_spread': 0.0,
 'late_p': 0.5}

There are no underscores between primary and to for example, which does not look very nice in my opinion. I think we should put that back in, or is there a reason why we do not want that?

Edit: I just went through the code and noticed, that you did it on purpose. There is generally no issue, I was just used to the old naming convention :)

rmnldwg commented 2 weeks ago

I liked it too, but when building composite models (such as the bilateral, midline, and eventually the mixing model) it is also nice to separate these layers by underscores. That way you'd have for example c1_ext_contra_TtoIII_spread as the contralateral spread from tumor to LNL III in case of midline extension in component 1 of the mixture model 😅

What you could do to visually separate the tumor, the to and the LNL is write the tumor name in caps. E.g. PRIMARYtoIII or TUMORtoIII or simply TtoIII.