More documentation on how to use package for theoretical distributions

[AmeliaMN]

I'm hoping to use infer this semester, and while I'm getting the idea of the simulations, I can't figure out the theoretical part.

• First I looked at the full pipeline vignette which says, for example, "One categorical variable (standardized proportion $z$): Not yet implemented."
• Then I went and read the traditional methods appendix from ModernDive, which showed me how to use the visualize() function. But then...
• I got the error message that visualize() should no longer be used to plot a p-value and now
• I can't figure out how to use shade_p_value()

Can someone point me to some current documentation on using infer for theoretical distributions?

[simonpcouch]

Hi there!

I can definitely see that the theoretical approaches aren't as well documented in examples and vignettes. I've just started a branch off of develop, theory-in-docs, to improve some of that coverage, and will be pushing some edits in the next few days.

The new vignette in the most recent version (0.5.1) on CRAN, accessible by vignette("infer"), spends some time with how to use shade_p_value(), though more so in the simulation context.

The most up to date documentation and vignettes, though, are on develop—since the last update, we've updated the full pipeline vignette, including using the updated API (to my knowledge), made some small changes to the infer vignette, and added some test-specific vignettes. (And, soon, more mention of the theoretical method throughout!) =)

I can't speak to how soon these updates will be sent to CRAN, though.

[AmeliaMN]

Thanks @simonpcouch! I appreciate the response to my very un-formed issue, and I'll watch the branch.

[github-actions]

This issue has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex: https://reprex.tidyverse.org) and link to this issue.