zo: zo

View source: R/zo.R

zoR Documentation

zo

Description

Creates a zero-order correlation matrix.

Usage

zo(
  data,
  cols,
  split,
  method = "pearson",
  adjust.p = "none",
  spround = TRUE,
  pasterisk = TRUE,
  bold_script = FALSE,
  bold_val = 0.3,
  message = TRUE,
  ...
)

Arguments

data

a data frame.

cols

the names of the columns to be included in the correlation matrix. Defaults to every column except the split column (if a split column is provided).

split

an optional string indicating the column that includes the grouping variable for producing different matrices above and below the diagonal.

method

a string indicating whether 'zo()' should return Pearson ('"pearson"'), Kendall ('"kendall"'), or Spearman ('"spearman') correlations. Defaults to '"pearson"'.

adjust.p

a string indicating what type of correction for multiple comparisons should be used. Defaults to '"none"'.

spround

a logical value indicating whether values should be rounded for printing. Defaults to 'TRUE'.

pasterisk

a logical value indicating whether p-values should be replaced with asterisks and combined with the regression coefficients. Defaults to 'TRUE'.

bold_script

if TRUE, bolds correlations over a certain size. Defaults to 'FALSE'.

bold_val

a numeric scalar that indicates the value or greater that should be bolded. Defaults to '.3'.

message

if TRUE, messages are generated telling the user which group is above and below the diagonal. Defaults to 'TRUE'.

...

optional arguments to be passed to pasterisk.


camkay/panoply documentation built on Jan. 17, 2025, 6:31 a.m.