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

trinary micro_mod and growth are not completely implemented #88

Closed YoelPH closed 1 week ago

YoelPH commented 1 week ago

In unilateral the sharing of micro_mod and growth are not fully implemented.

Lines 89 -92 indicate that is_micro_mod_shared and is_growth_shared exist:

        The ``is_micro_mod_shared`` and ``is_growth_shared`` parameters determine
        whether the microscopic involvement and growth parameters are shared among all
        LNLs. If they are set to ``True``, the parameters are set globally for all LNLs.
        If they are set to ``False``, the parameters are set individually for each LNL.

For growth this is not needed. By nature we can set all growth parameters with growth. For the micro_mod this does not exist. Hence, is_micro_mod_shared should exist, or the key word micro_mod should be changing all micro_mod parameters.
Maybe I am missing something, but I did not find this function in the code.

rmnldwg commented 1 week ago

The documentation is definitely wrong here...

But isn't the micro mod parameter simply set by using set_params(micro=0.5)? It should be similar (or the same) as the growth parameter. But because we cannot have underscores in the parameter names anymore, I had to change its name to micro instead of micro_mod, I think.

Could you check if it does or doesn't share the micro globally?

YoelPH commented 1 week ago

Ahh, I was looking for micro_mod, since it was in the documentation. But then it makes sense. I will check it as soon as my sampling is done. If it works as you said, everything (except the documentation) is fine.

YoelPH commented 1 week ago

It works :) Can be closed

rmnldwg commented 1 week ago

I'll keep it open until the docs are fixed.