Skip to content

Commit 12dada0

Browse files
bump to devel
1 parent 5862391 commit 12dada0

21 files changed

+70
-72
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Type: Package
22
Package: ggstatsplot
33
Title: 'ggplot2' Based Plots with Statistical Details
4-
Version: 0.12.5
4+
Version: 0.12.5.9000
55
Authors@R:
66
c(person(given = "Indrajeet",
77
family = "Patil",

NEWS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# ggstatsplot 0.12.5
1+
# ggstatsplot 0.12.5.9000
22

33
N.B. All statistical analysis in `{ggstatsplot}` is carried out in
44
`{statsExpressions}`. Thus, to see changes related to statistical expressions,
55
read the `NEWS` for that package:
66
<https://indrajeetpatil.github.io/statsExpressions/news/index.html>
77

8+
# ggstatsplot 0.12.5
9+
810
## MAJOR CHANGES
911

1012
- `extract_stats()` returns a list of class `ggstatsplot_stats` which

R/ggcoefstats.R

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,30 @@
77
#' confidence interval whiskers and other statistical details included as
88
#' labels.
99
#'
10+
#' Although the statistical models displayed in the plot may differ based on the
11+
#' class of models being investigated, there are few aspects of the plot that will
12+
#' be invariant across models:
13+
#'
14+
#' - The dot-whisker plot contains a dot representing the **estimate** and their
15+
#' **confidence intervals** (`95%` is the default). The estimate can either be
16+
#' effect sizes (for tests that depend on the `F`-statistic) or regression
17+
#' coefficients (for tests with `t`-, $\chi^{2}$-, and `z`-statistic), etc. The
18+
#' function will, by default, display a helpful `x`-axis label that should
19+
#' clear up what estimates are being displayed. The confidence intervals can
20+
#' sometimes be asymmetric if bootstrapping was used.
21+
#'
22+
#' - The label attached to dot will provide more details from the statistical
23+
#' test carried out and it will typically contain estimate, statistic, and
24+
#' *p*-value.
25+
#'
26+
#' - The caption will contain diagnostic information, if available, about
27+
#' models that can be useful for model selection: The smaller the Akaike's
28+
#' Information Criterion (**AIC**) and the Bayesian Information Criterion
29+
#' (**BIC**) values, the "better" the model is.
30+
#'
31+
#' - The output of this function will be a `{ggplot2}` object and, thus,
32+
#' it can be further modified (e.g. change themes) with `{ggplot2}`.
33+
#'
1034
#' @section Summary of graphics:
1135
#'
1236
#' ```{r child="man/rmd-fragments/ggcoefstats_graphics.Rmd"}

README.Rmd

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -643,34 +643,10 @@ For more, also read the following vignette:
643643
### `ggcoefstats()`
644644

645645
The function `ggcoefstats()` generates **dot-and-whisker plots** for
646-
regression models saved in a tidy data frame. The tidy data frames are prepared
646+
regression models. The tidy data frames are prepared
647647
using `parameters::model_parameters()`. Additionally, if available, the model
648648
summary indices are also extracted from `performance::model_performance()`.
649649

650-
Although the statistical models displayed in the plot may differ based on the
651-
class of models being investigated, there are few aspects of the plot that will
652-
be invariant across models:
653-
654-
- The dot-whisker plot contains a dot representing the **estimate** and their
655-
**confidence intervals** (`95%` is the default). The estimate can either be
656-
effect sizes (for tests that depend on the `F`-statistic) or regression
657-
coefficients (for tests with `t`-, $\chi^{2}$-, and `z`-statistic), etc. The
658-
function will, by default, display a helpful `x`-axis label that should
659-
clear up what estimates are being displayed. The confidence intervals can
660-
sometimes be asymmetric if bootstrapping was used.
661-
662-
- The label attached to dot will provide more details from the statistical
663-
test carried out and it will typically contain estimate, statistic, and
664-
*p*-value.e
665-
666-
- The caption will contain diagnostic information, if available, about
667-
models that can be useful for model selection: The smaller the Akaike's
668-
Information Criterion (**AIC**) and the Bayesian Information Criterion
669-
(**BIC**) values, the "better" the model is.
670-
671-
- The output of this function will be a `{ggplot2}` object and, thus, it can be
672-
further modified (e.g. change themes) with `{ggplot2}` functions.
673-
674650
```{r}
675651
#| label = "ggcoefstats1",
676652
#| fig.height = 5,

README.md

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -626,37 +626,11 @@ For more, also read the following vignette:
626626
### `ggcoefstats()`
627627

628628
The function `ggcoefstats()` generates **dot-and-whisker plots** for
629-
regression models saved in a tidy data frame. The tidy data frames are
630-
prepared using `parameters::model_parameters()`. Additionally, if
631-
available, the model summary indices are also extracted from
629+
regression models. The tidy data frames are prepared using
630+
`parameters::model_parameters()`. Additionally, if available, the model
631+
summary indices are also extracted from
632632
`performance::model_performance()`.
633633

634-
Although the statistical models displayed in the plot may differ based
635-
on the class of models being investigated, there are few aspects of the
636-
plot that will be invariant across models:
637-
638-
- The dot-whisker plot contains a dot representing the **estimate** and
639-
their **confidence intervals** (`95%` is the default). The estimate
640-
can either be effect sizes (for tests that depend on the
641-
`F`-statistic) or regression coefficients (for tests with `t`-,
642-
$`\chi^{2}`$-, and `z`-statistic), etc. The function will, by default,
643-
display a helpful `x`-axis label that should clear up what estimates
644-
are being displayed. The confidence intervals can sometimes be
645-
asymmetric if bootstrapping was used.
646-
647-
- The label attached to dot will provide more details from the
648-
statistical test carried out and it will typically contain estimate,
649-
statistic, and *p*-value.e
650-
651-
- The caption will contain diagnostic information, if available, about
652-
models that can be useful for model selection: The smaller the
653-
Akaike’s Information Criterion (**AIC**) and the Bayesian Information
654-
Criterion (**BIC**) values, the “better” the model is.
655-
656-
- The output of this function will be a `{ggplot2}` object and, thus, it
657-
can be further modified (e.g. change themes) with `{ggplot2}`
658-
functions.
659-
660634
``` r
661635
set.seed(123)
662636

man/dot-grouped_list.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/extract_stats.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/ggbarstats.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/ggbetweenstats.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/ggcoefstats.Rd

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

man/ggdotplotstats.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/gghistostats.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/ggpiestats.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/ggwithinstats.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/grouped_ggbarstats.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/grouped_ggbetweenstats.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/grouped_ggdotplotstats.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/grouped_gghistostats.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/grouped_ggpiestats.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/grouped_ggscatterstats.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/grouped_ggwithinstats.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)