New diagnostic warnings will be confusing until default output is changed
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 1.1k
- Forks
- 266
- Avg merge
- 2h 56m
- Merged PRs (30d)
- 1
Description
@avehtari and I are talking about this at the moment and we think it will be very confusing to users to warn them about the new MCMC diagnostics (e.g, bulk and tail ess)
when these new diagnostics are not yet included in the default output. If we aren't going to wait for the new diagnostics to be the default output before warning users about them then I think we should at least point them in the warning message to the functions that can be used to access these quantities instead of just giving the URL to the Stan warnings document.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read rstan/R/check_hmc_diagnostics.R around line 86 and inspect how the new MCMC diagnostics are currently warned about versus shown in default output. Confirm the intended direction with the discussion, then update the warning or default output so users can find these diagnostics; done means the warning is not confusing and points to their access functions when needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- data
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100