cols.corr: Chart of columns correlation with a selected dimension

Description Usage Arguments Examples

View source: R/cols_corr.R

Description

This function allows to calculate the correlation (sqrt(COS2)) of the column categories with the selected dimension.

The function displays the correlation of the column categories with the selected dimension; the parameter sort=TRUE arrange the categories in decreasing order of correlation. At the left-hand side, the categories' labels show a symbol (+ or -) according to which side of the selected dimension they are correlated, either positive or negative. The categories are grouped into two groups: categories correlated with the positive ('pole +') or negative ('pole -') pole of the selected dimension. At the right-hand side, a legend (which is enabled/disabled using the 'leg' parameter) indicates the row categories' contribution (in permills) to the selected dimension (value enclosed within round brackets), and a symbol (+ or -) indicating whether they are actually contributing to the definition of the positive or negative side of the dimension, respectively. Further, an asterisk (*) flags the categories which can be considered major contributors to the definition of the dimension.

Usage

1
2
3
cols.corr(data, x = 1, sort = TRUE, filter = FALSE, leg = TRUE,
  dotprightm = 5, cex.leg = 0.6, cex.labls = 0.75, leg.x.spc = 1,
  leg.y.spc = 1)

Arguments

data:

name of the dataset (must be in dataframe format).

x:

dimension for which the column categories correlation is returned (1st dimension by default).

sort:

logical value (TRUE/FALSE) which allows to sort the categories in descending order of correlation with the selected dimension. TRUE is set by default.

filter:

filter the row categories listed in the top-right legend, only showing those who have a major contribution to the definition of the selected dimension.

leg:

enable (TRUE; default) or disable (FALSE) the legend at the right-hand side of the dotplot.

dotprightm:

increases the empty space between the right margin of the dotplot and the left margin of the legend box.

cex.leg:

adjust the size of the legend's characters.

cex.labls:

adjust the size of the dotplot's labels.

leg.x.spc:

adjust the horizontal space of the chart's legend. See more info from the 'legend' function's help (?legend).

leg.y.spc:

adjust the y interspace of the chart's legend. See more info from the 'legend' function's help (?legend).

Examples

1
2
data(greenacre_data)
cols.corr(greenacre_data, 1, sort=TRUE) #Plots the correlation of the column categories with the 1st CA dimension.

gianmarcoalberti/CAinterprTools documentation built on May 31, 2018, 6:59 a.m.