Skip to content

Commit 8f5aee6

Browse files
committed
add NEWS item and document support for posterior draws format
1 parent ae573cd commit 8f5aee6

12 files changed

+86
-45
lines changed

NEWS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
# bayesplot 1.8.1.9000
44

5+
* `mcmc_*()` functions now support all draws formats from the **posterior** package. (#277, @Ozan147)
6+
57
* `mcmc_dens()` and `mcmc_dens_overlay()` gain arguments for controlling the
68
the density calculation. (#258)
79

R/mcmc-overview.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
#' have already been merged), or a data frame with one column per parameter plus
2626
#' an additional column `"Chain"` that contains the chain number (an integer)
2727
#' corresponding to each row in the data frame.
28+
#' * __draws__: Any of the `draws` formats supported by the
29+
#' \pkg{\link{posterior}} package.
2830
#'
2931
#' __Note__: typically the user should *not* include warmup iterations
3032
#' in the object passed to **bayesplot** plotting functions, although for

man-roxygen/args-mcmc-x.R

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
#' @param x A 3-D array, matrix, list of matrices, or data frame of MCMC draws.
2-
#' The [MCMC-overview] page provides details on how to specify each these
3-
#' allowed inputs. It is also possible to use an object with an
4-
#' `as.array()` method that returns the same kind of 3-D array described on
5-
#' the [MCMC-overview] page.
1+
#' @param x An object containing MCMC draws:
2+
#' * A 3-D array, matrix, list of matrices, or data frame. The [MCMC-overview]
3+
#' page provides details on how to specify each these.
4+
#' * A `draws` object from the \pkg{\link{posterior}} package (e.g.,
5+
#' `draws_array`, `draws_rvars`, etc.).
6+
#' * An object with an `as.array()` method that returns the same kind of 3-D
7+
#' array described on the [MCMC-overview] page.
8+
#'

man/MCMC-combos.Rd

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-diagnostics.Rd

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-distributions.Rd

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-intervals.Rd

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-overview.Rd

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-parcoord.Rd

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-recover.Rd

Lines changed: 9 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)