[Stable]
This function uses the correlation::correlation() to generate the correlation table.

cor_test(
  data,
  cols,
  ...,
  digits = 3,
  method = "pearson",
  p_adjust = "holm",
  streamline = FALSE,
  quite = FALSE,
  return_result = FALSE
)

Arguments

data

data frame

cols

correlation items. Support dplyr::select() syntax.

...

additional arguments passed to correlation::correlation(). See ?correlation::correlation. Note that the return data.frame from correlation::correlation() must contains r and p (e.g., passing baysesian = TRUE will not work)

digits

number of digits to round to

method

Default is "pearson". Options are "kendall", "spearman","biserial", "polychoric", "tetrachoric", "biweight", "distance", "percentage", "blomqvist", "hoeffding", "gamma", "gaussian","shepherd", or "auto". See ?correlation::correlation for detail

p_adjust

Default is "holm". Options are "hochberg", "hommel", "bonferroni", "BH", "BY", "fdr", "somers" or "none". See ?stats::p.adjust for more detail

streamline

print streamlined output.

quite

suppress printing output

return_result

If it is set to TRUE, it will return the data frame of the correlation table

Value

data frame of the correlation table

Examples

cor_test(iris, where(is.numeric))
#> Model Summary
#> Model Type = Correlation
#> Model Method = pearson
#> Adjustment Method = holm
#> 
#> ───────────────────────────────────────────────────────
#>            Var  Sepal.Length  Sepal.Width  Petal.Length
#> ───────────────────────────────────────────────────────
#>   Sepal.Length                                         
#>    Sepal.Width    -0.118                               
#>   Petal.Length     0.872 ***   -0.428 ***              
#>    Petal.Width     0.818 ***   -0.366 ***     0.963 ***
#> ───────────────────────────────────────────────────────