Skip to content

Commit fb533f2

Browse files
committed
minor doc cleaning
[ci skip]
1 parent 75e31a3 commit fb533f2

13 files changed

+16
-11
lines changed

NEWS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@
5050
[`?ppc_loo_pit_overlay()`](https://mc-stan.org/bayesplot/reference/PPC-loo.html)
5151
now work as expected. (#166, #167)
5252

53-
* `ppc_bars()` and `ppc_bars_grouped()` now allow negative integers as input. (#172)
53+
* `ppc_bars()` and `ppc_bars_grouped()` now allow negative integers as input.
54+
(#172, @jeffpollock9)
5455

5556

5657
# bayesplot 1.6.0

R/helpers-mcmc.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ prepare_mcmc_array <- function(x,
1111
if (is_df_with_chain(x)) {
1212
x <- df_with_chain2array(x)
1313
} else if (is_chain_list(x)) {
14+
# this will apply to mcmc.list and similar objects
1415
x <- chain_list2array(x)
1516
} else if (is.data.frame(x)) {
1617
# data frame without Chain column
1718
x <- as.matrix(x)
1819
} else {
20+
# try object's as.array method
1921
x <- as.array(x)
2022
}
2123

R/mcmc-overview.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
#' chain or all chains have already been merged), or a data frame with one
2626
#' column per parameter plus an additional column `"Chain"` that contains the
2727
#' chain number (an integer) corresponding to each row in the data frame.
28+
#'
2829
#' __Note__: typically the user should *not* include warmup iterations
2930
#' in the object passed to **bayesplot** plotting functions, although for
3031
#' certain plots (e.g. trace plots) it can occasionally be useful to include the

man-roxygen/args-mcmc-x.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#' @param x A 3-D array, matrix, list of matrices, or data frame of MCMC draws.
22
#' The [MCMC-overview] page provides details on how to specify each these
33
#' 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
4+
#' `as.array()` method that returns the same kind of 3-D array described on
55
#' the [MCMC-overview] page.

man/MCMC-combos.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-diagnostics.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-distributions.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-intervals.Rd

Lines changed: 1 addition & 1 deletion
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 & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/MCMC-parcoord.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)