Extend man page

[Thibaultfq]

By looking at the source code, I found out about a cool feature that i needed but is nowhere mentioned. This is, the "target" parameter in the summary of a easycorrelation object. I needed a matrix of the correlations but with p and df (degrees of freedom) values. This is available, though separately, by using the parameter "target".

example to get the p-values of a correlation matrix or for each correlation test:

results <- correlation(iris)
summary(results, target="p")
## # Correlation Matrix (pearson-method)
##
## Parameter    | Petal.Width | Petal.Length | Sepal.Width
## -------------------------------------------------------
## Sepal.Length |    9.30e-37 |     5.19e-47 |        0.15
## Sepal.Width  |    8.15e-06 |     1.35e-07 |            
## Petal.Length |    2.81e-85 |              |             

example to get the degrees of freedom of each correlation test (here all equal, but not always the case)
example:

results <- correlation(iris)
summary(results, target="n_Obs")
## # Correlation Matrix (pearson-method)
##
## Parameter    | Petal.Width | Petal.Length | Sepal.Width
## -------------------------------------------------------
## Sepal.Length |   150.00*** |    150.00*** |      150.00
## Sepal.Width  |   150.00*** |    150.00*** |            
## Petal.Length |   150.00*** |              |                  

Using tidyverse and as_tibble, one can easily add these two together creating all the info needed in one matrix.

[DominiqueMakowski]

Hi @Thibaultfq, would you be interested in contributing a small PR to add this to the docs somewhere :) ?

[etiennebacher]

By the way, all functions in R/methods.easycorrelation.R should be properly documented, not just summary.easycorrelation() (but @Thibaultfq feel free to document as many as you want if you want to contribute)