Skip to content

Commit

Permalink
Ready for CRAN? (#776)
Browse files Browse the repository at this point in the history
  • Loading branch information
IndrajeetPatil committed Aug 11, 2022
1 parent aeb73d7 commit d0cfbbd
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 90 deletions.
16 changes: 8 additions & 8 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ message: 'To cite package "ggstatsplot" in publications use:'
type: software
license: GPL-3.0-only
title: 'ggstatsplot: ''ggplot2'' Based Plots with Statistical Details'
version: 0.9.3.9000
version: 0.9.4
doi: 10.21105/joss.03167
abstract: 'Extension of ''ggplot2'', ''ggstatsplot'' creates graphics with details
from statistical tests included in the plots themselves. It provides an easier syntax
Expand Down Expand Up @@ -268,8 +268,8 @@ references:
email: vincent.arel-bundock@umontreal.ca
orcid: https://orcid.org/0000-0003-2042-7063
year: '2022'
url: https://easystats.github.io/insight/
version: '>= 0.18.0.1'
url: https://CRAN.R-project.org/package=insight
version: '>= 0.18.2'
- type: software
title: paletteer
abstract: 'paletteer: Comprehensive Collection of Color Palettes'
Expand Down Expand Up @@ -308,8 +308,8 @@ references:
email: brenton@wiernik.org
orcid: https://orcid.org/0000-0001-9560-6336
year: '2022'
url: https://easystats.github.io/parameters/
version: '>= 0.18.1.8'
url: https://CRAN.R-project.org/package=parameters
version: '>= 0.18.2'
- type: software
title: patchwork
abstract: 'patchwork: The Composer of Plots'
Expand Down Expand Up @@ -351,8 +351,8 @@ references:
email: brenton@wiernik.org
orcid: https://orcid.org/0000-0001-9560-6336
year: '2022'
url: https://easystats.github.io/performance/
version: '>= 0.9.1.1'
url: https://CRAN.R-project.org/package=performance
version: '>= 0.9.2'
- type: software
title: purrr
abstract: 'purrr: Functional Programming Tools'
Expand Down Expand Up @@ -400,7 +400,7 @@ references:
given-names: Indrajeet
email: patilindrajeet.science@gmail.com
orcid: https://orcid.org/0000-0003-1995-6531
version: '>= 1.3.2.9000'
version: '>= 1.3.3'
year: '2022'
- type: software
title: tidyr
Expand Down
15 changes: 5 additions & 10 deletions 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.9.3.9000
Version: 0.9.4
Authors@R:
c(person(given = "Indrajeet",
family = "Patil",
Expand Down Expand Up @@ -37,22 +37,17 @@ Imports:
ggrepel,
ggsignif,
glue,
insight (>= 0.18.0.1),
insight (>= 0.18.2),
paletteer,
parameters (>= 0.18.1.8),
parameters (>= 0.18.2),
patchwork,
performance (>= 0.9.1.1),
performance (>= 0.9.2),
purrr,
rlang,
stats,
statsExpressions (>= 1.3.2.9000),
statsExpressions (>= 1.3.3),
tidyr,
utils
Remotes:
easystats/insight,
easystats/parameters,
easystats/performance,
IndrajeetPatil/statsExpressions
Suggests:
afex,
BayesFactor (>= 0.9.12-4.4),
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.9.3.9000
# ggstatsplot 0.9.4

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>

- Internal housekeeping to adjust to changes in upstream dependencies.

# ggstatsplot 0.9.3

- Hot fix release to correct a failing example in CRAN daily checks.
Expand Down
100 changes: 50 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ hours working on this package rather than what I was paid to do. 😁
To see the detailed documentation for each function in the stable
**CRAN** version of the package, see:

- [Publication](https://joss.theoj.org/papers/10.21105/joss.03167)
- [Publication](https://joss.theoj.org/papers/10.21105/joss.03167)

- [Vignettes](https://indrajeetpatil.github.io/ggstatsplot/articles/)
- [Vignettes](https://indrajeetpatil.github.io/ggstatsplot/articles/)

- [Presentation](https://indrajeetpatil.github.io/ggstatsplot_slides/slides/ggstatsplot_presentation.html#1)
- [Presentation](https://indrajeetpatil.github.io/ggstatsplot_slides/slides/ggstatsplot_presentation.html#1)

## Summary of available plots

Expand Down Expand Up @@ -924,7 +924,7 @@ grouped_ggbarstats(
### `ggcoefstats`

The function `ggcoefstats` generates **dot-and-whisker plots** for
regression models saved in a tidy data frame. The tidy dataframes are
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
`performance::model_performance()`.
Expand All @@ -933,28 +933,28 @@ 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}](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;%5Cchi%5E%7B2%7D "\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.
- 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}](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;%5Cchi%5E%7B2%7D "\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 Expand Up @@ -1113,11 +1113,11 @@ For a more exhaustive account of this function, see the associated
vignette-
<https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/ggcoefstats.html>

### Extracting dataframes with statistical details
### Extracting data frames with statistical details

`{ggstatsplot}` also offers a convenience function to extract dataframes
with statistical details that are used to create expressions displayed
in `{ggstatsplot}` plots.
`{ggstatsplot}` also offers a convenience function to extract data
frames with statistical details that are used to create expressions
displayed in `{ggstatsplot}` plots.

``` r
set.seed(123)
Expand Down Expand Up @@ -1227,27 +1227,27 @@ ggplot(morley, aes(x = as.factor(Expt), y = Speed)) +

## Summary of benefits of using `{ggstatsplot}`

- No need to use scores of packages for statistical analysis (e.g.,
one to get stats, one to get effect sizes, another to get Bayes
Factors, and yet another to get pairwise comparisons, etc.).
- No need to use scores of packages for statistical analysis (e.g., one
to get stats, one to get effect sizes, another to get Bayes Factors,
and yet another to get pairwise comparisons, etc.).

- Minimal amount of code needed for all functions (typically only
`data`, `x`, and `y`), which minimizes chances of error and makes
for tidy scripts.
- Minimal amount of code needed for all functions (typically only
`data`, `x`, and `y`), which minimizes chances of error and makes for
tidy scripts.

- Conveniently toggle between statistical approaches.
- Conveniently toggle between statistical approaches.

- Truly makes your figures worth a thousand words.
- Truly makes your figures worth a thousand words.

- No need to copy-paste results to the text editor (MS-Word, e.g.).
- No need to copy-paste results to the text editor (MS-Word, e.g.).

- Disembodied figures stand on their own and are easy to evaluate for
the reader.
- Disembodied figures stand on their own and are easy to evaluate for
the reader.

- More breathing room for theoretical discussion and other text.
- More breathing room for theoretical discussion and other text.

- No need to worry about updating figures and statistical details
separately.
- No need to worry about updating figures and statistical details
separately.

## Misconceptions about `{ggstatsplot}`

Expand Down Expand Up @@ -1281,12 +1281,12 @@ are encouraged.
Here are some simple ways in which you can contribute (in the increasing
order of commitment):

- Read and correct any inconsistencies in the
[documentation](https://indrajeetpatil.github.io/ggstatsplot/)
- Raise issues about bugs or wanted features
- Review code
- Add new functionality (in the form of new plotting functions or
helpers for preparing subtitles)
- Read and correct any inconsistencies in the
[documentation](https://indrajeetpatil.github.io/ggstatsplot/)
- Raise issues about bugs or wanted features
- Review code
- Add new functionality (in the form of new plotting functions or
helpers for preparing subtitles)

Please note that this project is released with a [Contributor Code of
Conduct](https://indrajeetpatil.github.io/ggstatsplot/CODE_OF_CONDUCT.html).
Expand Down
20 changes: 10 additions & 10 deletions codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"codeRepository": "https://github.com/IndrajeetPatil/ggstatsplot",
"issueTracker": "https://github.com/IndrajeetPatil/ggstatsplot/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.9.3.9000",
"version": "0.9.4",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down Expand Up @@ -398,14 +398,14 @@
"@type": "SoftwareApplication",
"identifier": "insight",
"name": "insight",
"version": ">= 0.18.0.1",
"version": ">= 0.18.2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://github.com/easystats/insight"
"sameAs": "https://CRAN.R-project.org/package=insight"
},
"10": {
"@type": "SoftwareApplication",
Expand All @@ -423,14 +423,14 @@
"@type": "SoftwareApplication",
"identifier": "parameters",
"name": "parameters",
"version": ">= 0.18.1.8",
"version": ">= 0.18.2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://github.com/easystats/parameters"
"sameAs": "https://CRAN.R-project.org/package=parameters"
},
"12": {
"@type": "SoftwareApplication",
Expand All @@ -448,14 +448,14 @@
"@type": "SoftwareApplication",
"identifier": "performance",
"name": "performance",
"version": ">= 0.9.1.1",
"version": ">= 0.9.2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://github.com/easystats/performance"
"sameAs": "https://CRAN.R-project.org/package=performance"
},
"14": {
"@type": "SoftwareApplication",
Expand Down Expand Up @@ -490,14 +490,14 @@
"@type": "SoftwareApplication",
"identifier": "statsExpressions",
"name": "statsExpressions",
"version": ">= 1.3.2.9000",
"version": ">= 1.3.3",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://github.com/IndrajeetPatil/statsExpressions"
"sameAs": "https://CRAN.R-project.org/package=statsExpressions"
},
"18": {
"@type": "SoftwareApplication",
Expand All @@ -518,7 +518,7 @@
},
"SystemRequirements": null
},
"fileSize": "9541.454KB",
"fileSize": "9541.381KB",
"citation": [
{
"@type": "ScholarlyArticle",
Expand Down
10 changes: 1 addition & 9 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,8 @@
## Test environments

* local Windows install, R 4.2.0

* ubuntu 18.04 (on gitub-actions-ci), R 4.2.0

* win-builder (devel and release)

## R CMD check results

0 errors | 0 warnings | 0 note

- Hot fix release to correct a failing example in CRAN daily checks.
- Internal housekeeping to adjust to changes in upstream dependencies.

## revdepcheck results

Expand Down
4 changes: 2 additions & 2 deletions man/reexports.Rd

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

0 comments on commit d0cfbbd

Please sign in to comment.