California-Planet-Search / radvel

General Toolkit for Modeling Radial Velocity Data
http://radvel.readthedocs.io
MIT License
57 stars 52 forks source link

minAfactor documentation #332

Closed zhexingli closed 3 years ago

zhexingli commented 3 years ago

I believe for mcmc to converge, minAfactor of the chain has to go above the default value of 40 (as indicated by the summary pdf as well), because autocorrelation time will plateau when the number of steps is large, giving N/tau a larger number. But in the documentation page, it says "once the minimum autocorreclation factor is below minAfactor, this criterion for convergence is met." This seems confusing.

bjfultn commented 3 years ago

I believe this is just a typo, "below" --> "above". @spencerhurt do you agree?

spencerhurt commented 3 years ago

You're right, this is just a typo. Submitted a pull request to the next-release branch.