aezarebski / timtam2

This repository is an implementation of the TimTam likelihood as a BEAST2 package.
https://aezarebski.github.io/timtam/
MIT License
3 stars 0 forks source link

Vignettes #24

Closed xieruopeng closed 2 years ago

xieruopeng commented 2 years ago

Can you kindly give a detailed description for the folders under doc/Vigettes?

What scenarios are these examples applicable to?

Thanks.

aezarebski commented 2 years ago

Hi @xieruopeng

Thank you for pointing this out.

At the moment I'm implementing time varying parameters (see the skyline branch) so the organisation of the code/vignettes will change soon and there may be breaking changes to the API so I would not advise using this "in production" unless you take care to note the exact commit you are using.

You're right, the layout is a bit confusing, I'll keep this in mind during the re-organisation and add some comments about intended use-cases. Currently, they are organised by the type of data (do you have scheduled or unscheduled sampling) and whether or not you want to estimate the tree (or just the rates and prevalence).

I'll leave this open as a reminder. If you have any further questions or suggestions, please let me know.

Cheers, Alex