metawards / MetaWards

MetaWards disease metapopulation analysis and modelling software. Professional geographical SIR model with a flexible plugin architecture to support complex scenario modelling
https://metawards.org
GNU General Public License v3.0
13 stars 6 forks source link

Confusion over the stages array in the disease file #118

Closed fentonscode closed 4 years ago

fentonscode commented 4 years ago

Description In tutorial 7 part 1, the lurgy example file contains 5 stages, yet the description text above shows 6 indices as [0, 5]. It is unclear whether the disease file lurgy_home.json is either [E, I1, I2, I3, R] or [, ...], where is the latent class of people exiting the S class.

chryswoods commented 4 years ago

The description at the top refers to the "lurgy4" that had been built up throughout the rest of the tutorial, which has 6 stages, as described. The "lurgy_home" and "lurgy_super" are the two new disease files that are introduced after this description, one of which has 5 stage (removed the pre-symptomatic state, as described) and the other has 6 stages (very infectious pre-symptomatic state).

For lurgy_home the states are [*, E, I2, I3, R] while for lurgy_super they are [*, E, I1, I2, I3, R]

chryswoods commented 4 years ago

Specifically in the tutorial directly before "lurgy_home" and "lurgy_super" there is;

"We would like to investigate how the percentage of these super-spreaders, and their mobility and infectivity affects the progression of the outbreak. To do this, we will create two demographics;

To start, we need to create disease files for the home and super demographics. Do this by creating two files, first lurgy_home.json that should contain;"

fentonscode commented 4 years ago

I see, it wasn't totally clear when first reading through it

For consistency of nomenclature, did we agree that * and E were to transform to E1 and E2?

chryswoods commented 4 years ago

Yes, in our discussions, but not in the docs. Star is called star, as the command line option "--star-as-E" means refer to star as E, while "--star-as-R" means refer to star as R, and "--disable-star" means remove the star state altogether. So, in the docs, I need to call it star as all of the tutorial is run using "--star-as-R". But feel free to call it E1 if you run using "--star-as-E"

chryswoods commented 4 years ago

Adding a note here from our email exchange that, yes, it is a typo when I wrote "We will move these individuals to stage 2, which is H2, in the patients demographic.". It should read "We will move these individuals to stage 2, which is H1, in the patients demographic."

fentonscode commented 4 years ago

If you call --disable-star does that change the indexing required in the movers?

chryswoods commented 4 years ago

No, as disable-star means that the first stage in the disease file (stage 0) is now interpreted as E, while the second stage is I1 etc. So the number of stages hasn’t changed, just how you interpret them.

It does mean that, for the same outbreak you should delete stage 0 from the disease file, i.e. reduce lurgy4 from 6 to 5 stages, and then, because you have changed the number of stages, you would need to reindex your movers.

chryswoods commented 4 years ago

I'm going to close this now as I don't think there is anything that needs to change. Please feel free to re-open if I am wrong :-)