Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Name options for simulate_summary() #118

Closed
jamesmbaazam opened this issue Dec 4, 2023 · 0 comments · Fixed by #235
Closed

Name options for simulate_summary() #118

jamesmbaazam opened this issue Dec 4, 2023 · 0 comments · Fixed by #235

Comments

@jamesmbaazam
Copy link
Member

jamesmbaazam commented Dec 4, 2023

Would it help to rename simulate_summary() to say, sample_tree_metrics()? This would then reserve 'simulate' for code that gives the tree structure. However, running summary(simulate_tree()) should also give the same-ish output as sample_tree_metrics() for the same ntrees and offspring_dist.

It's not really sampling. The current simulate_summary() function is running a stripped down version of simulate_tree() that only returns the chain_statistic of interest without tracking related information. Speaking out loud now, I think it's probably better to rename it to simulate_statistic(). I mentioned in the second bullet of #79 that the name simulate_summary() would need some reconsideration.

Originally posted by @jamesmbaazam in #107 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant