stan-dev / stan-dev/rstanarm

add more diagnostic output to summary(fit)

Open
#224 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature
Dominant language
R
Stars
401
Forks
136
PR merge metrics
No merged PRs in 30d

Description

Summary:

add divergences, treedepth exceedence, and energy diagnostics as discussed in Mike's case study http://mc-stan.org/users/documentation/case-studies/rstan_workflow.html to the printed output by summary(fit), where fit is a fit object from rstanarm

Description:

ShinyStan can be used to show all these diagnostics, but when making R notebooks it's nice to be able to get diagnostics summary also non-interactively. Mike's diagnostic utilities don't work for rstanarm fit objects. I think it would be good to show in summary(fit) by default also 0 divergences, 0 treedepth execeedence, passing the energy test.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the summary(fit) method for rstanarm fit objects and read the linked case study's diagnostic requirements. Compare the available fit diagnostics with the requested divergences, treedepth exceedances, and energy test, then verify that summary(fit) reports them non-interactively by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
data
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.