prepare: Prepare Data for Plotting

View source: R/dimensio-internal.R

prepareR Documentation

Prepare Data for Plotting

Description

Prepare Data for Plotting

Usage

prepare(
  x,
  margin,
  ...,
  axes = c(1, 2),
  active = TRUE,
  sup = TRUE,
  principal = TRUE,
  highlight = NULL,
  col = NULL,
  bg = NULL,
  pch = NULL,
  cex = NULL,
  lty = NULL,
  lwd = NULL,
  alpha = FALSE
)

Arguments

x

A MultivariateAnalysis object.

margin

A length-one numeric vector giving the subscript which the data will be returned: 1 indicates individuals/rows (the default), 2 indicates variables/columns.

...

Currently not used.

axes

A length-two numeric vector giving the dimensions to be plotted.

active

A logical scalar: should the active observations be plotted?

sup

A logical scalar: should the supplementary observations be plotted?

principal

A logical scalar: should principal coordinates be returned? If FALSE, standard coordinates are returned.

highlight

A vector specifying the information to be highlighted. If NULL (the default), no highlighting is applied. If a single character string is passed, it must be one of "observation", "mass", "sum", "contribution" or "cos2" (see augment()). Any unambiguous substring can be given.

col

The colors for lines and points.

bg

The background color for the open plot symbols given by pch = 21:25.

pch

A vector of plotting characters or symbols. This can either be a single character or an integer code for one of a set of graphics symbols.

cex

A numerical vector giving the amount by which plotting characters and symbols should be scaled relative to the default.

lty, lwd

A specification for the line type and width.

Value

A data.frame with the following columns:

x

Coordinates along x.

y

Coordinates along y.

z

Variable to be highlighted.

label

Label.

col

Color for lines and points.

bg

Background color.

pch

Symbol.

cex

Symbol size.

lty

Line type.

lwd

Line width.

Author(s)

N. Frerebeau


dimensio documentation built on Nov. 25, 2023, 1:08 a.m.