Skip to content

Commit

Permalink
bump to devel
Browse files Browse the repository at this point in the history
  • Loading branch information
IndrajeetPatil committed Nov 1, 2024
1 parent 5862391 commit 12dada0
Show file tree
Hide file tree
Showing 21 changed files with 70 additions and 72 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: ggstatsplot
Title: 'ggplot2' Based Plots with Statistical Details
Version: 0.12.5
Version: 0.12.5.9000
Authors@R:
c(person(given = "Indrajeet",
family = "Patil",
Expand Down
4 changes: 3 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# ggstatsplot 0.12.5
# ggstatsplot 0.12.5.9000

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

# ggstatsplot 0.12.5

## MAJOR CHANGES

- `extract_stats()` returns a list of class `ggstatsplot_stats` which
Expand Down
24 changes: 24 additions & 0 deletions R/ggcoefstats.R
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,30 @@
#' confidence interval whiskers and other statistical details included as
#' labels.
#'
#' Although the statistical models displayed in the plot may differ based on the
#' class of models being investigated, there are few aspects of the plot that will
#' be invariant across models:
#'
#' - The dot-whisker plot contains a dot representing the **estimate** and their
#' **confidence intervals** (`95%` is the default). The estimate can either be
#' effect sizes (for tests that depend on the `F`-statistic) or regression
#' coefficients (for tests with `t`-, $\chi^{2}$-, and `z`-statistic), etc. The
#' function will, by default, display a helpful `x`-axis label that should
#' clear up what estimates are being displayed. The confidence intervals can
#' sometimes be asymmetric if bootstrapping was used.
#'
#' - The label attached to dot will provide more details from the statistical
#' test carried out and it will typically contain estimate, statistic, and
#' *p*-value.
#'
#' - The caption will contain diagnostic information, if available, about
#' models that can be useful for model selection: The smaller the Akaike's
#' Information Criterion (**AIC**) and the Bayesian Information Criterion
#' (**BIC**) values, the "better" the model is.
#'
#' - The output of this function will be a `{ggplot2}` object and, thus,
#' it can be further modified (e.g. change themes) with `{ggplot2}`.
#'
#' @section Summary of graphics:
#'
#' ```{r child="man/rmd-fragments/ggcoefstats_graphics.Rmd"}
Expand Down
26 changes: 1 addition & 25 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -643,34 +643,10 @@ For more, also read the following vignette:
### `ggcoefstats()`

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

Although the statistical models displayed in the plot may differ based on the
class of models being investigated, there are few aspects of the plot that will
be invariant across models:

- The dot-whisker plot contains a dot representing the **estimate** and their
**confidence intervals** (`95%` is the default). The estimate can either be
effect sizes (for tests that depend on the `F`-statistic) or regression
coefficients (for tests with `t`-, $\chi^{2}$-, and `z`-statistic), etc. The
function will, by default, display a helpful `x`-axis label that should
clear up what estimates are being displayed. The confidence intervals can
sometimes be asymmetric if bootstrapping was used.

- The label attached to dot will provide more details from the statistical
test carried out and it will typically contain estimate, statistic, and
*p*-value.e

- The caption will contain diagnostic information, if available, about
models that can be useful for model selection: The smaller the Akaike's
Information Criterion (**AIC**) and the Bayesian Information Criterion
(**BIC**) values, the "better" the model is.

- The output of this function will be a `{ggplot2}` object and, thus, it can be
further modified (e.g. change themes) with `{ggplot2}` functions.

```{r}
#| label = "ggcoefstats1",
#| fig.height = 5,
Expand Down
32 changes: 3 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -626,37 +626,11 @@ For more, also read the following vignette:
### `ggcoefstats()`

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

Although the statistical models displayed in the plot may differ based
on the class of models being investigated, there are few aspects of the
plot that will be invariant across models:

- The dot-whisker plot contains a dot representing the **estimate** and
their **confidence intervals** (`95%` is the default). The estimate
can either be effect sizes (for tests that depend on the
`F`-statistic) or regression coefficients (for tests with `t`-,
$`\chi^{2}`$-, and `z`-statistic), etc. The function will, by default,
display a helpful `x`-axis label that should clear up what estimates
are being displayed. The confidence intervals can sometimes be
asymmetric if bootstrapping was used.

- The label attached to dot will provide more details from the
statistical test carried out and it will typically contain estimate,
statistic, and *p*-value.e

- The caption will contain diagnostic information, if available, about
models that can be useful for model selection: The smaller the
Akaike’s Information Criterion (**AIC**) and the Bayesian Information
Criterion (**BIC**) values, the “better” the model is.

- The output of this function will be a `{ggplot2}` object and, thus, it
can be further modified (e.g. change themes) with `{ggplot2}`
functions.

``` r
set.seed(123)

Expand Down
2 changes: 1 addition & 1 deletion man/dot-grouped_list.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/extract_stats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ggbarstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ggbetweenstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 23 additions & 1 deletion man/ggcoefstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ggdotplotstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/gghistostats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ggpiestats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ggwithinstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_ggbarstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_ggbetweenstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_ggdotplotstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_gghistostats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_ggpiestats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_ggscatterstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/grouped_ggwithinstats.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 12dada0

Please sign in to comment.