Usage
associationMatrix(dat=NULL, x=NULL, y=NULL, conf.level = .95, correction = "fdr", bootstrapV=FALSE, info=c("full", "ci", "es"), includeSampleSize = "depends", bootstrapV.samples = 5000, digits = 2, pValueDigits = digits + 1, colNames = FALSE, type=c("R", "html", "latex"), file="", statistic = associationMatrixStatDefaults, effectSize = associationMatrixESDefaults, var.equal = 'test')
Arguments
dat
A dataframe with the variables of interest. All variables in this
dataframe will be used if both x and y are NULL. If dat is NULL, the user
will be presented with a dialog to select a datafile.
x
If not NULL, this should be a character vector with the names of the
variables to include in the rows of the association table. If x is
NULL, all variables in the dataframe will be used.
y
If not NULL, this should be a character vector with the names of the
variables to include in the columns of the association table. If y is
NULL, the variables in x will be used for the columns as well (which
produces a symmetric matrix, similar to most correlation matrices). conf.level
Level of confidence of the confidence intervals.
correction
Correction for multiple testing: an element out of the vector
c("holm", "hochberg", "hommel", "bonferroni", "BH", "BY", "fdr", "none").
NOTE: the p-values are corrected for multiple testing;
The confidence intervals are not!
bootstrapV
Whether to use bootstrapping to compue the confidence interval for
Cramer's V or whether to use the Fisher's Z conversion.
info
Information to print: either both the confidence interval and the
point estimate for the effect size (and the p-value, corrected for
multiple testing), or only the confidence intervals, or only the point
estimate (and the corrected p-value). Must be on element of the vector
c("full", "ci", "es").
includeSampleSize
Whether to include the sample size when the effect size point estimate and
p-value are shown. If this is "depends", it will depend on whether all
associations have the same sample size (and the sample size will only be
printed when they don't). If "always", the sample size will always be added.
If anything else, it will never be printed.
bootstrapV.samples
If using boostrapping for Cramer's V, the number of samples to generate.
digits
Number of digits to round to when printing the results.
pValueDigits
How many digits to use for formatting the p values.
colNames
If true, the column heading will use the variables names instead of
numbers.
type
Type of output to generate: must be an element of the vector
c("R", "html", "latex").
file
If a file is specified, the output will be written to that file instead
of shown on the screen.
statistic
This is the complicated bit; this is where associationMatrix allows
customization of the used statistics to perform null hypothesis
significance testing. For everyday use, leaving this at the default value,
associationMatrixStatDefaults, works fine. In case you want to customize,
read the 'Notes' section below.
effectSize
Like the 'statistics' argument, 'effectSize also allows customization,
in this case of the used effect sizes. Again, the default value,
associationMatrixESDefaults, works for everyday use. Again, see the
'Notes' section below if you want to customize.
var.equal
Whether to test for equal variances ('test'), assume equality ('yes'), or assume unequality ('no'). See meanDiff
for more information.