ropensci / beautier

R package to generate the same BEAST2 XML parameter files as generated by BEAUti 2
https://docs.ropensci.org/beautier
GNU General Public License v3.0
13 stars 2 forks source link

Improve doc create_mcmc #119

Closed richelbilderbeek closed 3 years ago

richelbilderbeek commented 3 years ago

From @thijsjanzen:

Het enige waar we tegenaan liepen was het rare gedrag / conflicterende gedrag van bijv:

beautier::create_mcmc(chain_length = 1e6, store_every = 10000, tracelog = beautier::create_tracelog(log_every = 2500))

of nog verwarrender:

beautier::create_mcmc(chain_length = 1e6, tracelog = beautier::create_tracelog(log_every = 2500)) # op welke freq worden nu trees gelogged?

alsmede, deze code breakt de relatie tussen likelihoods en trees in log.out en trees.out, waardoor bijv de MAP tree niet meer te achterhalen is (of lastiger in ieder geval).

Kortom, store_every en log_every verwijzen beiden naar vergelijkbare events, en het is niet duidelijk welke "de baas is". Daarnaast is niet duidelijk wat de default waarde van store_every is (default is -1 ?).

Improve the documentation to clear out these points.

richelbilderbeek commented 3 years ago

Done!