Skip to content

Commit c3fc6f2

Browse files
Update yrep/ypred docs to mention posterior::draws support
1 parent af14ccb commit c3fc6f2

13 files changed

Lines changed: 79 additions & 66 deletions

man-roxygen/args-y-yrep.R

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
#' @param y A vector of observations. See **Details**.
22
#' @param yrep An `S` by `N` matrix of draws from the posterior (or prior)
3-
#' predictive distribution. The number of rows, `S`, is the size of the
4-
#' posterior (or prior) sample used to generate `yrep`. The number of columns,
5-
#' `N` is the number of predicted observations (`length(y)`). The columns of
6-
#' `yrep` should be in the same order as the data points in `y` for the plots
7-
#' to make sense. See the **Details** and **Plot Descriptions** sections for
8-
#' additional advice specific to particular plots.
3+
#' predictive distribution, or a [`posterior::draws`] object. The number of
4+
#' rows, `S`, is the size of the posterior (or prior) sample used to generate
5+
#' `yrep`. The number of columns, `N` is the number of predicted observations
6+
#' (`length(y)`). The columns of `yrep` should be in the same order as the
7+
#' data points in `y` for the plots to make sense. See the **Details** and
8+
#' **Plot Descriptions** sections for additional advice specific to particular
9+
#' plots.

man-roxygen/args-ypred.R

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
#' @param ypred An `S` by `N` matrix of draws from the posterior (or prior)
2-
#' predictive distribution. The number of rows, `S`, is the size of the
3-
#' posterior (or prior) sample used to generate `ypred`. The number of
4-
#' columns, `N`, is the number of predicted observations.
2+
#' predictive distribution, or a [`posterior::draws`] object. The number of
3+
#' rows, `S`, is the size of the posterior (or prior) sample used to generate
4+
#' `ypred`. The number of columns, `N`, is the number of predicted
5+
#' observations.

man/PPC-censoring.Rd

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

man/PPC-discrete.Rd

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

man/PPC-distributions.Rd

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

man/PPC-errors.Rd

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

man/PPC-intervals.Rd

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

man/PPC-loo.Rd

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

man/PPC-scatterplots.Rd

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

man/PPC-test-statistics.Rd

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

0 commit comments

Comments
 (0)