epiverse-trace / epichains

[Under active development] Methods for simulating and analysing the sizes and lengths of infectious disease transmission chains from branching process models
https://epiverse-trace.github.io/epichains/
Other
5 stars 2 forks source link

columns in return values of `simulate_tree` #175

Closed sbfnk closed 4 months ago

sbfnk commented 8 months ago

I think the names of the columns in simulate_tree and their documentation could be improved.

Especially:

I'm also wondering if _id really needs to be added to the column names or whether they could just be index_case, infectee, infector.

So instead of currently something like

+   infectee_id sim_id infector_id generation time
1            1      1          NA          1    0
2            2      1          NA          1    0
3            3      1          NA          1    0
4            1      2           1          2    3
5            2      2           1          2    3
6            3      2           1          2    3
7            1      3           1          2    3
8            2      3           1          2    3
9            3      3           1          2    3

one would have something like

+   index_case infectee infector generation time
1            1       1       NA          1    0
2            2       2       NA          1    0
3            3       3       NA          1    0
4            1       4        1          2    3
5            2       5        2          2    3
6            3       6        3          2    3
7            1       7        1          2    3
8            2       8        2          2    3
9            3       9        3          2    3
jamesmbaazam commented 4 months ago

Closing as completed in #242.