Releases: mjskay/tidybayes
Releases · mjskay/tidybayes
tidybayes 3.0.7
tidybayes 3.0.6
Deprecations:
- Using
recover_types()with character vectors is now deprecated, as the
expected order of the levels of the variable is ambiguous, leading to
hard-to-spot errors where indices and names do not line up correctly. A
warning message has been added suggesting the use of factors instead. (#312)
Bug fixes:
- Make test for
residual_draws()more robust (due to change in default value
of themethodargument tobrms::residuals()). (#313)
tidybayes 3.0.4
Bug fixes:
- Fix test for
summarise_draws.grouped_df()due to changes in how
posterior::summarise_draws()handles thenum_argsargument.
tidybayes 3.0.3
- Much improved documentation of the difference between
epred,linpred, and
predictedinadd_XXX_rvars(). - Fixes for compatibility with changes and deprecations in
dplyrandtidyr. - Add note about argument name changes to
fitted_draws()deprecation warning (#288). - More correct error message for
epred_draws()on rethinking models. - Use
posterior::as_draws_df()instead ofAs.mcmc.list()forrstanobjects.
tidybayes 3.0.2
tidybayes 3.0.1
Minor update for compatibility with brms 2.16.0.
tidybayes 3.0.0
Breaking changes and deprecations:
- The
[add_]XXX_draws()(predicted_draws(),add_predicted_draws(), etc)
functions have been substantially restructured:add_fitted_draws()andfitted_draws()are now deprecated, along with the
scaleargument. Several years' teaching experience has demonstrated that
"fitted" is a very confusing name for students. Use the more-specific
[add_]linpred_draws()if you want draws from the linear predictor or the new
[add_]epred_draws()if you want draws from the expectation of the
posterior predictive (which is whatfitted_draws()was most typically
used for).- Arguments for renaming output columns are now all called
value, but
retain function-specific default column names. E.g. thepredictionargument
forpredicted_draws()is now spelledvaluebut has a default of".prediction".
One breaking change is that the default output column forlinpred_draws()
is now".linpred"instead of".value". This should make it easier to
combine outputs across multiple functions while also making it easier to
remember the name of the argument that changes the output column name. - The
nargument is now spelledndrawsto be more consistent with
terminology in theposteriorpackage and to prevent partial argument
name matching bugs withnewdata. - The first argument to all of these functions is now
objectinstead of
model, in order to match with argument names inposterior_predict(), etc.
This was necessary to prevent partial argument name matching bugs with
certain model types inrstanarmthat have anmargument to their
prediction functions.
New features:
- Support for the new
posteriorpackage:- Several new
_rvarscounterparts to the_drawsfamily of functions,
includingspread_rvars(),gather_rvars(),epred_rvars(),linpred_rvars(),
andpredicted_rvars(), which add columns ofposterior::rvar()objects
to data frames instead of long-format columns of draws. These can be
easier to read and take up less memory than the long-format data frames
of draws. Seevignette("tidy-posterior")for examples. - The
nest_rvars()andunnest_rvars()functions for converting between
data frames ofrvars and long format data frames of draws. tidy_draws()has been rebuilt on top ofposterior::as_draws_df(), which
means it should support even more model types and benefit from efficiency
improvements inposterior. This means thatcmdstanris now supported,
for example.- An implementation of
posterior::summarise_draws()for grouped data frames
of draws:summarise_draws.grouped_df() compare_levels()now supports data frames ofposterior::rvar()s.
- Several new
- The
epred_draws(),linpred_draws(), andpredicted_draws()functions should
now support any models that implementposterior_epred(),posterior_linpred(),
andposterior_predict()so long as they take anewdataargument. - Several dependencies have been removed or demoted to Suggests, including
forcats,plyr, andpurrr. - Added the option to set the
seedwhen subsampling to several functions (#276).
New documentation:
vignette("tidy-posterior")describing the use oftidybayeswithposterior,
and particularly theposterior::rvar()data type. This vignette also includes
an updated version of the ordinal regression example fromvignette("tidy-brms"),
now with an illustration of the relationship between the latent linear predictor
and the category-level probabilities.
Bug fixes:
- Omit sampler parameters in
tidy_draws()if retrieving them results in an error (#244)
tidybayes 2.3.1
tidybayes 2.1.1
- Initial split of
tidybayesintotidybayesandggdist(#250).ggdistnow contains all stats/geoms from
tidybayes (except deprecated ones), all support functions for stats/geoms (such aspoint_interval()),
vignette("slabinterval"), andvignette("freq-uncertainty-vis").tidybayesretains all other functions,
and re-exports allggdistfunctions for now. - All stats and geoms now support automatic orientation detection (#257), following the new automatic orientation
detection approach inggplot2. If needed, this can be overridden using the existingorientationparameter.- All
h-suffix geoms are now deprecated. Theh-suffix geoms have been left intidybayesand give a
deprecation warning when used; they cannot be used fromggdistdirectly. - The
h-suffixpoint_interval()functions are also deprecated, since they are not needed in tidybayes
nor inggplot2::stat_summary(). geom_interval(),geom_pointinterval(), andgeom_lineribbon()no longer automatically set the
yminandymaxaesthetics if.loweror.upperare present in the data. This allows them to work
better with automatic orientation detection (and was a bad feature to have existed in the first place
anyway). The deprecatedtidybayes::geom_intervalh()andtidybayes::geom_pointintervalh()still
automatically set those aesthetics, since they are deprecated anyway (so supporting the old behavior
is fine in these functions).
- All
geom_lineribbon()/stat_lineribbon()now supports astepargument for creating stepped lineribbons (#249).
H/T to Solomon Kurz for the suggestion.ggdistnow has its own implementation of the scaled and shifted Student's t distribution (dstudent_t(),
qstudent_t(), etc), since it is very useful for visualizing confidence distributions. That is re-exported
intidybayesas well`.- All deprecated functions and geoms now throw deprecation warnings (previously, several deprecated functions
did not).
tidybayes 2.0.3
Minor fixes for changes in tibble 3.0.0