Corrplot

https://github.com/taiyun/corrplot
Admin
Corrplot is an R package that provides a visual exploratory tool for correlation matrices,...
Tokens:3,956
Snippets:8
Trust Score:8.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install corrplot Package

Source: https://github.com/taiyun/corrplot/blob/master/README.md

Provides instructions for installing the corrplot R package from CRAN and the development version from GitHub.

```bash
install.packages('corrplot')
```

```bash
devtools::install_github('taiyun/corrplot', build_vignettes = TRUE)
```

--------------------------------

### Get Citation for corrplot

Source: https://github.com/taiyun/corrplot/blob/master/README.md

Shows how to retrieve the proper citation for the corrplot R package using the built-in R command.

```r
citation('corrplot')
```

--------------------------------

### Basic corrplot Usage

Source: https://github.com/taiyun/corrplot/blob/master/README.md

Demonstrates the basic usage of the corrplot function in R to visualize a correlation matrix. It includes ordering the matrix using hierarchical clustering and adding rectangles to group variables.

```r
library(corrplot)
M = cor(mtcars)
corrplot(M, order = 'hclust', addrect = 2)
```

--------------------------------

### corrplot() Ordering Options

Source: https://github.com/taiyun/corrplot/blob/master/NEWS.md

Describes the changes in the 'order' parameter for the corrplot() function, specifically the renaming of 'PCA' to 'AOE' and the addition of 'FPC' for ordering based on the first principal component.

```APIDOC
corrplot() - 'order' parameter:

- 'AOE': Represents ordering based on Average Euclidean Distance (formerly 'PCA').
- 'FPC': Added for ordering based on the First Principal Component.
```

--------------------------------

### corrplot Documentation and Dependency Updates

Source: https://github.com/taiyun/corrplot/blob/master/NEWS.md

Details on documentation revisions and changes in package dependencies for the corrplot R package. This includes updates to vignette engines, suggested packages, and citation information.

```R
# corrplot 0.92
  *  Revise the document.

# corrplot 0.90
  *  Revise the document. (thanks, Shuai Huang)

# corrplot 0.89
  *  Revise the document

# corrplot 0.88
  *  Revise the document
  *  Change vignette engine from 'knitr::knitr' to 'knitr::rmarkdown'
  *  Use 'prettydoc' package creating vignettes
  *  Set 'rmarkdown' and 'prettydoc' as Suggests packages

# corrplot 0.83
  *  CITATION now uses fields from DESCRIPTION
  *  RColorBrewer is now a suggested package (not required)

# corrplot 0.82
  *  Added more examples to the vignette

# corrplot 0.81
  *  updated vignette

# corrplot 0.77
  *  Revised document.

```

--------------------------------

### corrplot() Parameter Updates and New Features

Source: https://github.com/taiyun/corrplot/blob/master/NEWS.md

Details changes and new features in the corrplot() function across different versions. This includes parameter renaming, addition of new parameters like 'zoom' and 'cl.lim', and modifications to existing ones like 'tl.pos' and 'cl.pos'. It also covers the handling of matrices not within the [-1,1] range.

```APIDOC
corrplot(): Visualization of correlation matrices.

Key Parameter Changes and Additions:

- 'zoom': Added to handle matrices not in the [-1,1] range. Use with caution, ensuring visualization remains meaningful.
- 'is.corr': Added for visualizing non-correlation matrices.
- 'tl.pos': Renamed from 'addtextlabel' for text label position.
- 'cl.pos': Renamed from 'addcolorlabel' for color label position.
- 'cl.lim': Added for setting color label limits.
- 'addCoefasPercent': Added to display coefficients as percentages.
- 'tl.cex': Made more sensitive for text label size.

Removed Parameters:

- 'zoom' (in version 0.60, reintroduced later with new functionality)
- 'assign.col'
- 'cl.range'
- 'corrplot.circle()', 'corrplot.ellipse()', 'corrplot.square()', 'corrplot.shade()', 'corrplot.color()', 'corrplot.number()': These specific visualization types have been removed.

Related Functions:

- corrRect(): Renamed from corr.rect().
- corrMatOrder(): New function for matrix ordering.
- corrplot.mixed(): New function for mixed visualizations.

Bug Fixes:

- Margin spacing issues resolved, especially with long text labels or large font sizes.
- Incorrect color assignment to glyphs fixed.
```

--------------------------------

### corrplot() Parameter Changes and New Features

Source: https://github.com/taiyun/corrplot/blob/master/NEWS.md

Details parameter updates and new functionalities introduced in various versions of the corrplot R package. This includes changes to `tl.pos`, `insig`, `na.label`, `win.asp`, `outline`, `lower.col`, `upper.col`, `lim.segment`, and the return value of the function.

```R
## corrplot 0.91
  *  `tl.pos` add a new parameter `'l'` in `corrplot()`. (thanks, @ggordn3r)
  *  Add new function `COL1()`: Get sequential colors.
  *  Add new function `COL2()`: Get diverging colors.

## corrplot 0.90
  *  Add customizable rectangles to correlation plots in `corrRect()`.(#185, requirements from @douglaswhitaker thanks).
  *  Remove `clus`; add `index` and `name` parameters in `corrRect()`. 
  *  Add `xName`, `yName` two columns in `corrPos` data frame(e.g. `corrplot(...)$corrPos`).
  *  Rename parameter `cl.lim` to `col.lim` in `corrplot()`. 
  *  Add `arg` to the `corrplot()` return list.
  *  Add pipe operator `|>` examples when using corrRect().
  *  Parameter `number.digits` also works on p-value. (thanks, @bassam-abulnoor)

## corrplot 0.89
  *  Change the return value of corrplot() and corrplot.mixed() from matrix `corr` to `list(corr, corrPos)`
  *  Parameter `addCoef.col` works prior to parameter `insig`

## corrplot 0.83
  *  Fixed #99 : A new option insig = 'label_sig' to mark significant correlations.

## corrplot 0.82
  *  Fixed #18: title position and pie corrplot background circle.Used existing parameter `outline` to control the border color of pie symbols.
  *  Fixed #66: `lim.segment` parameter default value. Added default value 'auto' for `lim.segment` parameter
  *  Fixed #76: corrplot.mixed with black color correlation coefficient.Added two new parameters `lower.col` and `upper.col`
  *  Fixed #79: Changing aspect ratio for the plot.Added a new parameter `win.asp` which controls the aspect ratio of the plotted matrix.

## corrplot 0.81
  *  Fixed #79: added parameter `win.asp` to control aspect ratio
  *  Fixed #18: parameter `outline` combined with `method='pie'` controls
    the color of the otline circle of each pie.

## corrplot 0.80
  *  Fixed #70: Enable to plot a matrix with NA when 'is.corr = F'

## corrplot 0.77
  *  Fixed #58: make sure the margin is correct in corrplot.mixed().

## corrplot 0.76
  *  In corrplot(), added parameters na.label and na.label.col that define how NA values inside a matrix should be rendered.
  *  In corrplot(), na.label can now use one or two characters, default is '?' (issue #55)
  *  Fixed #9: added ward.D and ward.D2 hclust methods (thanks, #jeffzemla)

## corrplot 0.70
  *  In corrplot(), parameter insig add a  option 'p-value', now p-values can be conveniently added on the glyph.
  *  Return value changes, corrplot() now returns a reordered correlation matrix.
```

--------------------------------

### corrplot Bug Fixes

Source: https://github.com/taiyun/corrplot/blob/master/NEWS.md

Details bug fixes implemented across various versions of the corrplot R package, addressing issues related to significant occurrences, correlation formatting, plot parameters, color assignments, and NA value handling.

```R
# corrplot 0.95
  *  Fix #279: Version 0.94 is not assigning significant ocurrences correctly. (thanks, @brenoliisboa and @david-priest)
  
  
# corrplot 0.94
  *  Fix #275: format correlations with `nsmall = number.digits`. (thanks, @the-mad-statter)

  
# corrplot 0.93
  *  Fix #247: `addgrid.col` and `bg` don't work in mixed plot. (thanks, @ZoomMan91)
  *  Fix #246: using `insig = "n"` and `p.mat` sometimes causes an error. (thanks, @Sumidu)
  *  Fix #255: add new parameter `transKeepSign`, whether or not to keep matrix values' sign when transforming non-corr matrix.

# corrplot 0.92
  *  Fix #228: assigning colors incorrectly when `is.corr = FALSE`. (thanks, @bixiou)
  *  Fix #232: some functions wrongly marked as pure.
  *  Fix colorlegend lables alignment when `type = 'lower'`.
  *  Revise the document.

# corrplot 0.88
  *  Revise the document
  *  Remove full_col and fix #152 #157 #165 #166
  *  Fix #150 in document, it should be the arcus tangens functions. (thanks, @surmann)
  *  Change vignette engine from 'knitr::knitr' to 'knitr::rmarkdown'
  *  Use 'prettydoc' package creating vignettes
  *  Set 'rmarkdown' and 'prettydoc' as Suggests packages

# corrplot  0.87
  *  Change to the MIT license
  *  Fix #142: NA issues when cl.lim is supplied. (thanks, @AlexChristensen)

# corrplot 0.82
  *  Fixed #10: corrplot with type = 'upper' and long colname strings cuts off top labels
  *  Fixed #19: Color Legend has 0 width when only 1 column is used
  *  Fixed #70: NA errors when is.corr = F
  *  Fixed #77: Error when the matrix(corr) contains NA values.

# corrplot 0.76
  *  Fixed #16: checks for [-1, 1] interval are too strict.
  *  Fixed #15: error with correlation plot using insig argument when all values are significant.
```
Tokens:
Raw