Skip to content

Commit

Permalink
Prepare for CRAN (#249)
Browse files Browse the repository at this point in the history
  • Loading branch information
IndrajeetPatil authored Aug 7, 2022
1 parent b94bb15 commit 4307db5
Show file tree
Hide file tree
Showing 11 changed files with 202 additions and 53 deletions.
10 changes: 3 additions & 7 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Type: Package
Package: correlation
Title: Methods for Correlation Analysis
Version: 0.8.1.2
Version: 0.8.2
Authors@R:
c(person(given = "Dominique",
family = "Makowski",
Expand Down Expand Up @@ -51,14 +51,10 @@ Depends:
Imports:
bayestestR (>= 0.12.1),
datasets,
datawizard (>= 0.4.1.10),
datawizard (>= 0.5.0),
insight (>= 0.18.0),
parameters (>= 0.18.1),
stats
Remotes:
easystats/insight,
easystats/datawizard,
easystats/parameters
Suggests:
BayesFactor,
poorman,
Expand All @@ -85,6 +81,6 @@ VignetteBuilder:
knitr
Encoding: UTF-8
Language: en-US
RoxygenNote: 7.2.0
RoxygenNote: 7.2.1
Config/testthat/edition: 3
Roxygen: list(markdown = TRUE)
4 changes: 3 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# correlation 0.8.1.1
# correlation 0.8.2

- Maintenance release for *datawizard* package update.

# correlation 0.8.1

Expand Down
1 change: 0 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ The `cor_test()` function, for pairwise correlations, is also very convenient fo
plot(cor_test(iris, "Sepal.Width", "Sepal.Length"))
```


## Grouped dataframes

The `correlation()` function also supports **stratified correlations**, all within the
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,21 +59,21 @@ Click on the buttons above to access the package
[easystats blog](https://easystats.github.io/blog/posts/), and check-out
these vignettes:

- [Types of
Correlation](https://easystats.github.io/correlation/articles/types.html)
- [Multilevel
Correlations](https://easystats.github.io/correlation/articles/multilevel.html)
- [Types of
Correlation](https://easystats.github.io/correlation/articles/types.html)
- [Multilevel
Correlations](https://easystats.github.io/correlation/articles/multilevel.html)

# Features

The *correlation* package can compute many different types of
correlation, including:

**Pearson’s correlation**<br> ✅ **Spearman’s rank correlation**<br>
**Kendall’s rank correlation**<br> ✅ **Biweight midcorrelation**<br>
**Distance correlation**<br> ✅ **Percentage bend correlation**<br>
**Shepherd’s Pi correlation**<br> ✅ **Blomqvist’s coefficient**<br>
**Hoeffding’s D**<br> ✅ **Gamma correlation**<br> ✅ **Gaussian rank
**Pearson’s correlation**<br> ✅ **Spearman’s rank correlation**<br>
**Kendall’s rank correlation**<br> ✅ **Biweight midcorrelation**<br>
**Distance correlation**<br> ✅ **Percentage bend correlation**<br>
**Shepherd’s Pi correlation**<br> ✅ **Blomqvist’s coefficient**<br>
**Hoeffding’s D**<br> ✅ **Gamma correlation**<br> ✅ **Gaussian rank
correlation**<br> ✅ **Point-Biserial and biserial correlation**<br> ✅
**Winsorized correlation**<br> ✅ **Polychoric correlation**<br> ✅
**Tetrachoric correlation**<br> ✅ **Multilevel correlation**<br>
Expand Down Expand Up @@ -201,14 +201,14 @@ It is very easy to switch to a **Bayesian framework**.
correlation(iris, bayesian = TRUE)
## # Correlation Matrix (pearson-method)
##
## Parameter1 | Parameter2 | rho | 95% CI | pd | % in ROPE | Prior | BF
## ------------------------------------------------------------------------------------------------------
## Sepal.Length | Sepal.Width | -0.11 | [-0.27, 0.03] | 92.30% | 43.55% | Beta (3 +- 3) | 0.509
## Sepal.Length | Petal.Length | 0.86 | [ 0.82, 0.90] | 100%*** | 0% | Beta (3 +- 3) | > 1000***
## Sepal.Length | Petal.Width | 0.81 | [ 0.74, 0.85] | 100%*** | 0% | Beta (3 +- 3) | > 1000***
## Sepal.Width | Petal.Length | -0.41 | [-0.54, -0.27] | 100%*** | 0% | Beta (3 +- 3) | > 1000***
## Sepal.Width | Petal.Width | -0.35 | [-0.49, -0.21] | 100%*** | 0.02% | Beta (3 +- 3) | > 1000***
## Petal.Length | Petal.Width | 0.96 | [ 0.95, 0.97] | 100%*** | 0% | Beta (3 +- 3) | > 1000***
## Parameter1 | Parameter2 | rho | 95% CI | pd | % in ROPE | Prior | BF
## --------------------------------------------------------------------------------------------------------
## Sepal.Length | Sepal.Width | -0.11 | [-0.26, 0.05] | 91.62% | 44.12% | Beta (3 +- 3) | 0.509
## Sepal.Length | Petal.Length | 0.86 | [ 0.82, 0.90] | 100%*** | 0% | Beta (3 +- 3) | 2.14e+43***
## Sepal.Length | Petal.Width | 0.81 | [ 0.75, 0.86] | 100%*** | 0% | Beta (3 +- 3) | 2.62e+33***
## Sepal.Width | Petal.Length | -0.41 | [-0.54, -0.27] | 100%*** | 0% | Beta (3 +- 3) | 3.49e+05***
## Sepal.Width | Petal.Width | -0.35 | [-0.49, -0.21] | 100%*** | 0.05% | Beta (3 +- 3) | 5.29e+03***
## Petal.Length | Petal.Width | 0.96 | [ 0.94, 0.97] | 100%*** | 0% | Beta (3 +- 3) | 1.24e+80***
##
## Observations: 150
```
Expand Down
11 changes: 7 additions & 4 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@

0 errors | 0 warnings | 0 notes

* This is a new release.
* Fixes breakage caused by *datawizard* package update.

## revdepcheck results

We checked 7 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
We checked 8 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

* We saw 0 new problems
* We failed to check 0 packages
* We saw 3 new problems
* We failed to check 0 packages

The problems in *effectsize*, *see*, and *statsExpressions* packages are due to
*datawizard* update, and unrelated to the current submission.
Binary file modified man/figures/README-12-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-7-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified man/figures/README-corr-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 27 additions & 20 deletions revdep/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,35 @@
# Platform

|field |value |
|:--------|:------------------------------------|
|version |R version 4.1.2 (2021-11-01) |
|os |Windows 10 x64 (build 22000) |
|system |x86_64, mingw32 |
|ui |RStudio |
|language |(EN) |
|collate |English_United States.1252 |
|ctype |English_United States.1252 |
|tz |America/New_York |
|date |2022-02-14 |
|rstudio |2021.09.1+372 Ghost Orchid (desktop) |
|pandoc |NA |
|field |value |
|:--------|:-----------------------------------------|
|version |R version 4.2.1 (2022-06-23) |
|os |macOS Monterey 12.4 |
|system |aarch64, darwin20 |
|ui |RStudio |
|language |(EN) |
|collate |en_US.UTF-8 |
|ctype |en_US.UTF-8 |
|tz |Europe/Berlin |
|date |2022-08-07 |
|rstudio |2022.07.0+548 Spotted Wakerobin (desktop) |
|pandoc |2.19 @ /usr/local/bin/ (via rmarkdown) |

# Dependencies

|package |old |new |<U+0394> |
|:-----------|:------|:------|:--|
|correlation |0.7.1 |0.8.0 |* |
|bayestestR |0.11.5 |0.11.5 | |
|datawizard |0.2.3 |0.2.3 | |
|insight |0.15.0 |0.15.0 | |
|parameters |0.16.0 |0.16.0 | |
|package |old |new |Δ |
|:-----------|:-----|:--------|:--|
|correlation |0.8.1 |0.8.2 |* |
|bayestestR |NA |0.12.1.2 |* |
|datawizard |NA |0.5.0 |* |
|insight |NA |0.18.0.4 |* |

# Revdeps

## New problems (3)

|package |version |error |warning |note |
|:------------------------------------------------|:-------|:------|:-------|:----|
|[effectsize](problems.md#effectsize) |0.7.0 |__+1__ | | |
|[see](problems.md#see) |0.7.1 |__+1__ |__+1__ | |
|[statsExpressions](problems.md#statsexpressions) |1.3.2 |__+1__ | | |

19 changes: 17 additions & 2 deletions revdep/cran.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,22 @@
## revdepcheck results

We checked 7 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.
We checked 8 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package.

* We saw 0 new problems
* We saw 3 new problems
* We failed to check 0 packages

Issues with CRAN packages are summarised below.

### New problems
(This reports the first line of each new failure)

* effectsize
checking tests ...

* see
checking examples ... ERROR
checking dependencies in R code ... WARNING

* statsExpressions
checking tests ...

129 changes: 128 additions & 1 deletion revdep/problems.md
Original file line number Diff line number Diff line change
@@ -1 +1,128 @@
*Wow, no problems at all. :)*
# effectsize

<details>

* Version: 0.7.0
* GitHub: https://github.com/easystats/effectsize
* Source code: https://github.com/cran/effectsize
* Date/Publication: 2022-05-26 13:20:02 UTC
* Number of recursive dependencies: 234

Run `revdep_details(, "effectsize")` for more info

</details>

## Newly broken

* checking tests ...
```
Running ‘spelling.R’
Running ‘testthat.R’
ERROR
Running the tests in ‘tests/testthat.R’ failed.
Last 13 lines of output:
7. └─effectsize (local) FUN(newX[, i], ...)
8. └─datawizard::ranktransform(x, method = "average", ..., verbose = FALSE)
── Error (test-rankES.R:76:5): kendalls_w ──────────────────────────────────────
Error in `UseMethod("ranktransform")`: no applicable method for 'ranktransform' applied to an object of class "character"
Backtrace:
...
1. └─effectsize::kendalls_w(M1) at test-rankES.R:76:4
2. └─effectsize:::.kendalls_w(data, verbose = verbose)
3. └─base::apply(data, 1, .safe_ranktransform, verbose = verbose)
4. └─effectsize (local) FUN(newX[, i], ...)
5. └─datawizard::ranktransform(x, method = "average", ..., verbose = FALSE)
[ FAIL 3 | WARN 3 | SKIP 11 | PASS 494 ]
Error: Test failures
Execution halted
```

# see

<details>

* Version: 0.7.1
* GitHub: https://github.com/easystats/see
* Source code: https://github.com/cran/see
* Date/Publication: 2022-06-20 14:20:02 UTC
* Number of recursive dependencies: 210

Run `revdep_details(, "see")` for more info

</details>

## Newly broken

* checking examples ... ERROR
```
Running examples in ‘see-Ex.R’ failed
The error most likely occurred in:
> ### Name: coord_radar
> ### Title: Radar coordinate system
> ### Aliases: coord_radar
>
> ### ** Examples
>
> # Create a radar/spider chart with ggplot:
...
Attaching package: ‘poorman’
The following objects are masked from ‘package:stats’:
filter, lag
Loading required package: ggplot2
Error in FUN(X[[i]], ...) : object 'Name' not found
Calls: <Anonymous> ... <Anonymous> -> f -> scales_add_defaults -> lapply -> FUN
Execution halted
```

* checking dependencies in R code ... WARNING
```
Missing or unexported object: ‘datawizard::data_rescale’
```

# statsExpressions

<details>

* Version: 1.3.2
* GitHub: https://github.com/IndrajeetPatil/statsExpressions
* Source code: https://github.com/cran/statsExpressions
* Date/Publication: 2022-05-20 19:50:02 UTC
* Number of recursive dependencies: 158

Run `revdep_details(, "statsExpressions")` for more info

</details>

## Newly broken

* checking tests ...
```
Running ‘spelling.R’
Running ‘testthat.R’
ERROR
Running the tests in ‘tests/testthat.R’ failed.
Last 13 lines of output:
5. │ └─effectsize:::.kendalls_w(data, verbose = verbose)
6. │ └─base::apply(data, 1, .safe_ranktransform, verbose = verbose)
7. │ └─effectsize (local) FUN(newX[, i], ...)
8. │ └─datawizard::ranktransform(x, method = "average", ..., verbose = FALSE)
9. ├─statsExpressions:::tidy_model_effectsize(.)
...
10. │ ├─dplyr::bind_cols(...)
11. │ │ └─rlang::list2(...)
12. │ └─... %>% select(-contains("term"))
13. ├─dplyr::select(., -contains("term"))
14. ├─insight::standardize_names(., style = "broom")
15. └─dplyr::mutate(., effectsize = stats::na.omit(effectsize::get_effectsize_label(colnames(.))))
[ FAIL 2 | WARN 2 | SKIP 52 | PASS 33 ]
Error: Test failures
Execution halted
```

0 comments on commit 4307db5

Please sign in to comment.