Learn R Programming

dimensio

Overview

Simple Principal Components Analysis (PCA; see vignette("pca")) and (Multiple) Correspondence Analysis (CA) based on the Singular Value Decomposition (SVD). This package provides S4 classes and methods to compute, extract, summarize and visualize results of multivariate data analysis. It also includes methods for partial bootstrap validation.

There are many very good packages for multivariate data analysis (such as FactoMineR, ade4, vegan or ca, all extended by FactoExtra). dimensio is designed to be as simple as possible, providing all the necessary tools to explore the results of the analysis.


To cite dimensio in publications use:

Frerebeau N (2024). dimensio: Multivariate Data Analysis. Université Bordeaux Montaigne, Pessac, France. doi:10.5281/zenodo.4478530 https://doi.org/10.5281/zenodo.4478530, R package version 0.10.1, https://packages.tesselle.org/dimensio/.

This package is a part of the tesselle project https://www.tesselle.org.

Installation

You can install the released version of dimensio from CRAN with:

install.packages("dimensio")

And the development version from GitHub with:

# install.packages("remotes")
remotes::install_github("tesselle/dimensio")

Usage

## Load package
library(dimensio)

Compute

## Load data
data(iris)

## Compute PCA
X <- pca(iris, center = TRUE, scale = TRUE, sup_quali = "Species")

Extract

dimensio provides several methods to extract the results:

  • get_data() returns the original data.
  • get_contributions() returns the contributions to the definition of the principal dimensions.
  • get_coordinates() returns the principal or standard coordinates.
  • get_correlations() returns the correlations between variables and dimensions.
  • get_cos2() returns the cos2 values (i.e. the quality of the representation of the points on the factor map).
  • get_eigenvalues() returns the eigenvalues, the percentages of variance and the cumulative percentages of variance.

Visualize

The package allows to quickly visualize the results:

  • biplot() produces a biplot.
  • screeplot() produces a scree plot.
  • viz_rows()/viz_individuals() displays row/individual principal coordinates.
  • viz_columns()/viz_variables() displays columns/variable principal coordinates. viz_variables() depicts the variables by rays emanating from the origin (both their lengths and directions are important to the interpretation).
  • viz_contributions() displays (joint) contributions.
  • viz_cos2() displays (joint) cos2.

The viz_*() functions allow to highlight additional information by varying different graphical elements (color, transparency, shape and size of symbols…).

## Form biplot
biplot(X, type = "form")
## Highlight species
viz_individuals(
  x = X, 
  extra_quali = iris$Species, 
  color = c("#004488", "#DDAA33", "#BB5566")
)
## Add ellipses
viz_tolerance(
  x = X, 
  group = iris$Species, 
  level = 0.95,
  color = c("#004488", "#DDAA33", "#BB5566")
)

## Highlight petal length
viz_individuals(
  x = X,
  extra_quanti = iris$Petal.Length,
  color = color("iridescent")(255), 
  size = c(1, 2)
)

## Plot variables factor map
viz_variables(X)

## Scree plot
screeplot(X, eigenvalues = FALSE, cumulative = TRUE)

Translation

This package provides translations of user-facing communications, like messages, warnings and errors, and graphical elements (axis labels). The preferred language is by default taken from the locale. This can be overridden by setting of the environment variable LANGUAGE (you only need to do this once per session):

Sys.setenv(LANGUAGE = "<language code>")

Languages currently available are English (en) and French (fr).

Contributing

Please note that the dimensio project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

References

Aitchison, John, and Michael Greenacre. 2002. “Biplots of Compositional Data.” Journal of the Royal Statistical Society: Series C (Applied Statistics) 51 (4): 375–92. https://doi.org/10.1111/1467-9876.00275.

Gower, J. C. 1966. “Some Distance Properties of Latent Root and Vector Methods Used in Multivariate Analysis.” Biometrika 53 (3-4): 325–38. https://doi.org/10.1093/biomet/53.3-4.325.

Greenacre, Michael J. 1984. Theory and Applications of Correspondence Analysis. London ; Orlando, Fla: Academic Press.

———. 2007. Correspondence Analysis in Practice. Seconde edition. Interdisciplinary Statistics Series. Boca Raton: Chapman & Hall/CRC.

———. 2010. Biplots in Practice. Bilbao: Fundación BBVA.

Lebart, Ludovic, Marie Piron, and Alain Morineau. 2006. Statistique exploratoire multidimensionnelle : Visualisations et inférences en fouilles de données.

Lockyear, Kris. 2013. “Applying Bootstrapped Correspondence Analysis to Archaeological Data.” Journal of Archaeological Science 40 (12): 4744–53. https://doi.org/10.1016/j.jas.2012.08.035.

Ringrose, T. J. 1992. “Bootstrapping and Correspondence Analysis in Archaeology.” Journal of Archaeological Science 19 (6): 615–29. https://doi.org/10.1016/0305-4403(92)90032-X.

Copy Link

Version

Install

install.packages('dimensio')

Monthly Downloads

657

Version

0.10.1

License

GPL (>= 3)

Issues

Pull Requests

Stars

Forks

Last Published

December 10th, 2024

Functions in dimensio (0.10.1)

BootstrapPCA-class

Bootstrap PCA Results
PCA-class

PCA Results
ca

Correspondence Analysis
cdt

Complete Disjunctive Table
loadings

Extract Loadings
MultivariateResults

Multivariate Data Analysis Results
boot

Partial Bootstrap Analysis
burt

Burt Table
pca

Principal Components Analysis
pcoa

Principal Coordinates Analysis
PCOA-class

PCoA Results
CA-class

CA Results
MCA-class

MCA Results
benthos

Benthos
biplot

Biplot
get_eigenvalues

Get Eigenvalues
label

Non-Overlapping Text Labels
reexports

Objects exported from other packages
mca

Multiple Correspondence Analysis
screeplot

Scree Plot
svd2

Singular Value Decomposition of a Matrix
MultivariateSummary

Summary of Multivariate Data Analysis
export

Export Results
tidy

Tidy Coordinates
dimensio-defunct

Defunct Functions in dimensio
get_coordinates

Get Coordinates
colours

Colours
countries

Countries
get_contributions

Get Contributions
viz_points

Build a Factor Map
viz_variables

Visualize Variables Factor Map
dimensio-deprecated

Deprecated Functions in dimensio
get_data

Get Original Data
prepare_legend

Build a Legend
prepare_plot

Prepare Data for Plotting
viz_biplot

Build a Biplot
plot

Plot Coordinates
predict

Predict New Coordinates
dimensio-package

dimensio: Multivariate Data Analysis
viz_individuals

Visualize Individuals Factor Map
viz_labels

Non-Overlapping Text Labels
dimnames

Dimnames of an Object
viz_contributions

Visualize Contributions and cos2
subset

Extract Parts of an Object
summary

Object Summaries
viz_wrap

Plot Envelopes
wrap

Wrap Observations
MultivariateAnalysis

Output of Multivariate Data Analysis
MultivariateBootstrap

Output of Bootstrap Replications
BootstrapCA-class

Bootstrap CA Results