viz_points: Build a Factor Map
In dimensio: Multivariate Data Analysis

viz_points

R Documentation

Build a Factor Map

Description

Build a Factor Map

Usage

viz_points(
  x,
  margin,
  axes,
  ...,
  active = TRUE,
  sup = TRUE,
  labels = list(filter = "contribution", n = 10),
  extra_quali = NULL,
  extra_quanti = NULL,
  color = NULL,
  fill = FALSE,
  symbol = NULL,
  size = c(1, 6),
  xlim = NULL,
  ylim = NULL,
  main = NULL,
  sub = NULL,
  xlab = NULL,
  ylab = NULL,
  ann = graphics::par("ann"),
  frame.plot = TRUE,
  panel.first = NULL,
  panel.last = NULL,
  legend = list(x = "topleft")
)

Arguments

`x`	A `CA`, `MCA` or `PCA` 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.
`axes`	A length-two `numeric` vector giving the dimensions to be plotted.
`...`	Currently not used.
`active`	A `logical` scalar: should the active observations be plotted?
`sup`	A `logical` scalar: should the supplementary observations be plotted?
`labels`	A `logical` scalar: should labels be drawn? Labeling a large number of points can be computationally expensive and make the graph difficult to read. A selection of points to label can be provided using a `list` of two named elements, `filter` (a string specifying how to filter the labels to be drawn) and `n` (an integer specifying the number of labels to be drawn). See examples below.
`extra_quali`	An optional vector of qualitative data for aesthetics mapping.
`extra_quanti`	An optional vector of quantitative data for aesthetics mapping. If a single `character` string is passed, it must be one of "`observation`", "`mass`", "`sum`", "`contribution`" or "`cos2`" (see `augment()`).
`color`	The colors for lines and points (will be mapped to `extra_quanti` or `extra_quali`; if both are set, the latter has priority). Ignored if set to `FALSE`.
`fill`	The background colors for points (will be mapped to `extra_quanti` or `extra_quali`; if both are set, the latter has priority). Ignored if set to `FALSE`.
`symbol`	A vector of plotting characters or symbols (will be mapped to `extra_quali`). This can either be a single character or an integer code for one of a set of graphics symbols. If `symbol` is a named a named vector, then the symbols will be associated with their name within `extra_quali`. Ignored if set to `FALSE`.
`size`	A length-two `numeric` vector giving range of possible sizes (greater than 0; will be mapped to `extra_quanti`). Ignored if set to `FALSE`.
`xlim`	A length-two `numeric` vector giving the x limits of the plot. The default value, `NULL`, indicates that the range of the finite values to be plotted should be used.
`ylim`	A length-two `numeric` vector giving the y limits of the plot. The default value, `NULL`, indicates that the range of the finite values to be plotted should be used.
`main`	A `character` string giving a main title for the plot.
`sub`	A `character` string giving a subtitle for the plot.
`xlab`, `ylab`	A `character` vector giving the x and y axis labels.
`ann`	A `logical` scalar: should the default annotation (title and x and y axis labels) appear on the plot?
`frame.plot`	A `logical` scalar: should a box be drawn around the plot?
`panel.first`	An `expression` to be evaluated after the plot axes are set up but before any plotting takes place. This can be useful for drawing background grids.
`panel.last`	An `expression` to be evaluated after plotting has taken place but before the axes, title and box are added.
`legend`	A `list` of additional arguments to be passed to `graphics::legend()`; names of the list are used as argument names. If `NULL`, no legend is displayed.