Skip to content

document definitions of column values (pvalue, zscore, etc.) #25

@bob-carpenter

Description

@bob-carpenter

The example in the README.md shows output columns

  • term
  • estimate
  • sd
  • zscore
  • lower
  • upper
  • pvalue

I could not find doc for them other than pvalue, which has doc in R/utils.R that says, "@return A number indicating the p-value."

I hate to double-up issues like this, but I would also suggest changing some of these column names to be more informative at first glance.

  • lower and upper are presumably quantiles, but the column headers don't say which ones. In my experience, users want to be able to control the quantiles, for instance to access the median or follow Richard McElreath's quirky lead in reporting prime number intervals in Statistical Rethinking.

  • estimate doesn't say which estimate the package is using is it a posterior mean (minimize expected square error), posterior median (minimize expected absolute error), or something else? I'm guessing it would be posterior mean since sd is one of the other columns.

  • pvalue, zscore don't mean anything to me in this context, other than for use in posterior predictive checks. I would have guessed that the pvalue is just the standard normal cdf of the zscore, but that's not the case from looking at the values. This is the proximate cause for me opening the issue---to ask what these meant.

P.S. I actually came here because we're looking for general output analysis packages to recommend for use with (R)Stan.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions