Skip to content

Commit e96f625

Browse files
committed
updating documentation and fixing tests
1 parent afcc2de commit e96f625

23 files changed

+73
-7512
lines changed

NAMESPACE

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ export(ppc_data)
123123
export(ppc_dens)
124124
export(ppc_dens_overlay)
125125
export(ppc_dens_overlay_grouped)
126+
export(ppc_dots)
126127
export(ppc_ecdf_overlay)
127128
export(ppc_ecdf_overlay_grouped)
128129
export(ppc_error_binned)
@@ -170,6 +171,7 @@ export(ppd_boxplot)
170171
export(ppd_data)
171172
export(ppd_dens)
172173
export(ppd_dens_overlay)
174+
export(ppd_dots)
173175
export(ppd_ecdf_overlay)
174176
export(ppd_freqpoly)
175177
export(ppd_freqpoly_grouped)

R/ppc-distributions.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#' dataset (row) in `yrep`. For these plots `yrep` should therefore
2929
#' contain only a small number of rows. See the **Examples** section.
3030
#' }
31-
#' \item{`ppc_qdotplot()`}{
31+
#' \item{`ppc_dots()`}{
3232
#' A dot plot plot is displayed for `y` and each dataset (row) in `yrep`.
3333
#' For these plots `yrep` should therefore contain only a small number of rows.
3434
#' See the **Examples** section. This function requires [ggdist::stat_dots] to be installed.
@@ -85,7 +85,7 @@
8585
#' ppc_pit_ecdf(y, yrep, prob = 0.99, plot_diff = TRUE)
8686
#' }
8787
#'
88-
#' # for ppc_hist,dens,freqpoly,boxplot,qdotplot definitely use a subset yrep rows so
88+
#' # for ppc_hist,dens,freqpoly,boxplot,dots definitely use a subset yrep rows so
8989
#' # only a few (instead of nrow(yrep)) histograms are plotted
9090
#' ppc_hist(y, yrep[1:8, ])
9191
#' \donttest{
@@ -97,7 +97,7 @@
9797
#' ppc_dens(y, yrep[200:202, ])
9898
#'
9999
#' # dot plot
100-
#' ppc_qdotplot(y, yrep[1:8, ])
100+
#' ppc_dots(y, yrep[1:8, ])
101101
#' }
102102
#'
103103
#' \donttest{
@@ -517,8 +517,8 @@ ppc_boxplot <-
517517

518518
#' @rdname PPC-distributions
519519
#' @export
520-
#' @template args-qdotplot
521-
ppc_qdotplot <-
520+
#' @template args-dots
521+
ppc_dots <-
522522
function(y,
523523
yrep,
524524
...,

R/ppd-distributions.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ ppd_hist <-
189189

190190
#' @rdname PPD-distributions
191191
#' @export
192-
ppd_qdotplot <-
192+
ppd_dots <-
193193
function(ypred,
194194
...,
195195
binwidth = NA,
File renamed without changes.

man/PPC-distributions.Rd

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

man/PPD-distributions.Rd

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

tests/testthat/_snaps/ppc-distributions/ppc-qdotplot-binwidth.new.svg renamed to tests/testthat/_snaps/ppc-distributions/ppc-dots-binwidth.svg

Lines changed: 1 addition & 1 deletion
Loading

tests/testthat/_snaps/ppc-distributions/ppc-qdotplot-default.new.svg renamed to tests/testthat/_snaps/ppc-distributions/ppc-dots-default.svg

Lines changed: 1 addition & 1 deletion
Loading

tests/testthat/_snaps/ppc-distributions/ppc-qdotplot-quantile-binwidth.new.svg renamed to tests/testthat/_snaps/ppc-distributions/ppc-dots-quantile-binwidth.svg

Lines changed: 1 addition & 1 deletion
Loading

tests/testthat/_snaps/ppc-distributions/ppc-qdotplot-quantile.new.svg renamed to tests/testthat/_snaps/ppc-distributions/ppc-dots-quantile.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)