Skip to content

Commit 88c1f46

Browse files
committed
update readme
1 parent 5843292 commit 88c1f46

6 files changed

+39
-22
lines changed

README.Rmd

+11-7
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ knitr::opts_chunk$set(
2020
)
2121
```
2222

23-
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02306/status.svg)](https://doi.org/10.21105/joss.02306) [![total](https://cranlogs.r-pkg.org/badges/grand-total/correlation)](https://cranlogs.r-pkg.org/)
24-
<!-- [![downloads](http://cranlogs.r-pkg.org/badges/correlation)](https://cran.r-project.org/package=correlation) -->
23+
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02306/status.svg)](https://doi.org/10.21105/joss.02306) [![downloads](https://cranlogs.r-pkg.org/badges/correlation)](https://cran.r-project.org/package=correlation)
24+
[![total](https://cranlogs.r-pkg.org/badges/grand-total/correlation)](https://cranlogs.r-pkg.org/)
2525

2626
`correlation` is an [**easystats**](https://github.com/easystats/easystats) package focused on correlation analysis. It's lightweight, easy to use, and allows for the computation of many different kinds of correlations, such as **partial** correlations, **Bayesian** correlations, **multilevel** correlations, **polychoric** correlations, **biweight**, **percentage bend** or **Sheperd's Pi** correlations (types of robust correlation), **distance** correlation (a type of non-linear correlation) and more, also allowing for combinations between them (for instance, *Bayesian partial multilevel correlation*).
2727

@@ -36,8 +36,7 @@ Makowski, D., Wiernik, B. M., Patil, I., Lüdecke, D., \& Ben-Shachar, M. S. (20
3636

3737
# Installation
3838

39-
[![CRAN](http://www.r-pkg.org/badges/version/correlation)](https://cran.r-project.org/package=correlation) [![correlation status badge](https://easystats.r-universe.dev/badges/correlation)](https://easystats.r-universe.dev) [![R-CMD-check](https://github.com/easystats/correlation/workflows/R-CMD-check/badge.svg?branch=main)](https://github.com/easystats/correlation/actions)
40-
[![codecov](https://codecov.io/gh/easystats/correlation/branch/master/graph/badge.svg)](https://app.codecov.io/gh/easystats/correlation)
39+
[![CRAN](https://www.r-pkg.org/badges/version/correlation)](https://cran.r-project.org/package=correlation) [![correlation status badge](https://easystats.r-universe.dev/badges/correlation)](https://easystats.r-universe.dev) [![codecov](https://codecov.io/gh/easystats/correlation/branch/main/graph/badge.svg)](https://app.codecov.io/gh/easystats/correlation)
4140

4241
The *correlation* package is available on CRAN, while its latest development version is available on R-universe (from _rOpenSci_).
4342

@@ -54,13 +53,18 @@ library("correlation")
5453

5554
> **Tip**
5655
>
57-
> **Instead of `library(correlation)`, use `library(easystats)`.**
58-
> **This will make all features of the easystats-ecosystem available.**
56+
> Instead of `library(bayestestR)`, use `library(easystats)`.
57+
> This will make all features of the easystats-ecosystem available.
5958
>
60-
> **To stay updated, use `easystats::install_latest()`.**
59+
> To stay updated, use `easystats::install_latest()`.
6160
6261
# Documentation
6362

63+
[![Documentation](https://img.shields.io/badge/documentation-correlation-orange.svg?colorB=E91E63)](https://easystats.github.io/correlation/)
64+
[![Blog](https://img.shields.io/badge/blog-easystats-orange.svg?colorB=FF9800)](https://easystats.github.io/blog/posts/)
65+
[![Features](https://img.shields.io/badge/features-correlation-orange.svg?colorB=2196F3)](https://easystats.github.io/correlation/reference/index.html)
66+
67+
6468
Check out package [website](https://easystats.github.io/correlation/) for documentation.
6569

6670
# Features

README.md

+27-15
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
# correlation <img src='man/figures/logo.png' align="right" height="139" />
33

44
[![DOI](https://joss.theoj.org/papers/10.21105/joss.02306/status.svg)](https://doi.org/10.21105/joss.02306)
5+
[![downloads](https://cranlogs.r-pkg.org/badges/correlation)](https://cran.r-project.org/package=correlation)
56
[![total](https://cranlogs.r-pkg.org/badges/grand-total/correlation)](https://cranlogs.r-pkg.org/)
6-
<!-- [![downloads](http://cranlogs.r-pkg.org/badges/correlation)](https://cran.r-project.org/package=correlation) -->
77

88
`correlation` is an
99
[**easystats**](https://github.com/easystats/easystats) package focused
@@ -31,11 +31,10 @@ work published 2020)
3131

3232
# Installation
3333

34-
[![CRAN](http://www.r-pkg.org/badges/version/correlation)](https://cran.r-project.org/package=correlation)
34+
[![CRAN](https://www.r-pkg.org/badges/version/correlation)](https://cran.r-project.org/package=correlation)
3535
[![correlation status
3636
badge](https://easystats.r-universe.dev/badges/correlation)](https://easystats.r-universe.dev)
37-
[![R-CMD-check](https://github.com/easystats/correlation/workflows/R-CMD-check/badge.svg?branch=main)](https://github.com/easystats/correlation/actions)
38-
[![codecov](https://codecov.io/gh/easystats/correlation/branch/master/graph/badge.svg)](https://app.codecov.io/gh/easystats/correlation)
37+
[![codecov](https://codecov.io/gh/easystats/correlation/branch/main/graph/badge.svg)](https://app.codecov.io/gh/easystats/correlation)
3938

4039
The *correlation* package is available on CRAN, while its latest
4140
development version is available on R-universe (from *rOpenSci*).
@@ -53,13 +52,17 @@ library("correlation")
5352

5453
> **Tip**
5554
>
56-
> **Instead of `library(correlation)`, use `library(easystats)`.**
57-
> **This will make all features of the easystats-ecosystem available.**
55+
> Instead of `library(bayestestR)`, use `library(easystats)`. This will
56+
> make all features of the easystats-ecosystem available.
5857
>
59-
> **To stay updated, use `easystats::install_latest()`.**
58+
> To stay updated, use `easystats::install_latest()`.
6059
6160
# Documentation
6261

62+
[![Documentation](https://img.shields.io/badge/documentation-correlation-orange.svg?colorB=E91E63)](https://easystats.github.io/correlation/)
63+
[![Blog](https://img.shields.io/badge/blog-easystats-orange.svg?colorB=FF9800)](https://easystats.github.io/blog/posts/)
64+
[![Features](https://img.shields.io/badge/features-correlation-orange.svg?colorB=2196F3)](https://easystats.github.io/correlation/reference/index.html)
65+
6366
Check out package [website](https://easystats.github.io/correlation/)
6467
for documentation.
6568

@@ -200,14 +203,23 @@ It is very easy to switch to a **Bayesian framework**.
200203
correlation(iris, bayesian = TRUE)
201204
## # Correlation Matrix (pearson-method)
202205
##
203-
## Parameter1 | Parameter2 | rho | 95% CI | pd | % in ROPE | Prior | BF
204-
## --------------------------------------------------------------------------------------------------------
205-
## Sepal.Length | Sepal.Width | -0.11 | [-0.26, 0.04] | 92.53% | 42.52% | Beta (3 +- 3) | 0.509
206-
## Sepal.Length | Petal.Length | 0.86 | [ 0.82, 0.90] | 100%*** | 0% | Beta (3 +- 3) | 2.14e+43***
207-
## Sepal.Length | Petal.Width | 0.81 | [ 0.75, 0.86] | 100%*** | 0% | Beta (3 +- 3) | 2.62e+33***
208-
## Sepal.Width | Petal.Length | -0.41 | [-0.54, -0.27] | 100%*** | 0% | Beta (3 +- 3) | 3.49e+05***
209-
## Sepal.Width | Petal.Width | -0.35 | [-0.48, -0.22] | 100%*** | 0.03% | Beta (3 +- 3) | 5.29e+03***
210-
## Petal.Length | Petal.Width | 0.96 | [ 0.95, 0.97] | 100%*** | 0% | Beta (3 +- 3) | 1.24e+80***
206+
## Parameter1 | Parameter2 | rho | 95% CI | pd | % in ROPE
207+
## --------------------------------------------------------------------------
208+
## Sepal.Length | Sepal.Width | -0.11 | [-0.27, 0.04] | 92.70% | 42.83%
209+
## Sepal.Length | Petal.Length | 0.86 | [ 0.82, 0.90] | 100%*** | 0%
210+
## Sepal.Length | Petal.Width | 0.81 | [ 0.75, 0.86] | 100%*** | 0%
211+
## Sepal.Width | Petal.Length | -0.41 | [-0.55, -0.28] | 100%*** | 0%
212+
## Sepal.Width | Petal.Width | -0.35 | [-0.49, -0.22] | 100%*** | 0%
213+
## Petal.Length | Petal.Width | 0.96 | [ 0.95, 0.97] | 100%*** | 0%
214+
##
215+
## Parameter1 | Prior | BF
216+
## ------------------------------------------
217+
## Sepal.Length | Beta (3 +- 3) | 0.509
218+
## Sepal.Length | Beta (3 +- 3) | 2.14e+43***
219+
## Sepal.Length | Beta (3 +- 3) | 2.62e+33***
220+
## Sepal.Width | Beta (3 +- 3) | 3.49e+05***
221+
## Sepal.Width | Beta (3 +- 3) | 5.29e+03***
222+
## Petal.Length | Beta (3 +- 3) | 1.24e+80***
211223
##
212224
## Observations: 150
213225
```

correlation.Rproj

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
Version: 1.0
2+
ProjectId: b600adde-bc2d-4161-a558-4bf664e7e805
23

34
RestoreWorkspace: No
45
SaveWorkspace: No

man/figures/README-12-1.png

-419 KB
Loading

man/figures/README-7-1.png

-96.1 KB
Loading

man/figures/README-corr-1.png

-138 KB
Loading

0 commit comments

Comments
 (0)