HTML.cormat: Write a correlation matrix with HTML formatting

In R2HTML: HTML exportation for R objects

Description

Although the class ‘cormat’ is not defined, the function is called HTML.cormat, to highlight the fact it should be called only with a correlation matrix.

Usage

  ## S3 method for class 'cormat'
HTML(x, file = get(".HTML.file"), digits = 2, append = TRUE,
    align = "center", caption = "", captionalign = "bottom",
    classcaption = "captiondataframe", classtable = "cormat",
    useCSS = TRUE, ...)

Arguments

x	a correlation matrix
file	target HTLM output
digits	number of digits to use for rounding
append	logical. If 'TRUE' output will be appended to 'file'; otherwise, it will overwrite the contents of 'file'
align	alignment to be used: center, left or right
caption	optional caption to append to the table
captionalign	alignment to be used for the caption: could be bottom or top
classcaption	CSS class to use for caption
classtable	CSS class to be used for the whole table (in html <table> statement)
useCSS	whether to use CSS or not for traffic highlighting
...	...

additional arguments passed to cat.

Details

Arguments have sensible defaults, so typical usage is:

    HTML.cormat(x, file=)
  

Value

returns (invisibly) the input

Note

“Highlighting traffic” is a simple technique which allows to have a visual representation of data. It is particularly well suited for correlation matrices in order to have at a glance the underlying (linear) structure of data. If your output doesn't rely on CSS styles, you should use useCSS=FALSE option, whihc hard codes grey levels for correlations.

For CSS uses, you can (re)define colours and other attributes for correlations in seq(0,1,length=11)-defined intervals. Some definitions could be equivalent, not showing any difference. You can, by example, redefine CSS so that only correlations greater than 0.9 are showned, and lower the size of cells, which could be usefull for veryu big datasets.

Author(s)

Eric Lecoutre

See Also

HTML

Examples

	tmpfic=HTMLInitFile(tempdir(),CSSFile="http://www.stat.ucl.ac.be/R2HTML/Pastel.css")
	data(iris)
	HTML(as.title("Fisher Iris dataset / Correlation matrix - normal matrix"),file=tmpfic)
	HTML(cor(iris[,1:4]), file=tmpfic)
	HTML(as.title("Fisher Iris dataset / Correlation matrix - traffic highlighting"),file=tmpfic)
	HTML.cormat(cor(iris[,1:4]), file=tmpfic)

	# File is generated, you can call the browser:
	## Not run: browseURL(tmpfic)

R2HTML documentation built on May 2, 2019, 5:11 p.m.