pca_biplot_plot {structToolbox} | R Documentation

## pca_biplot_plot class

### Description

2d scatter plot of principal component scores overlaid with principal component loadings.

### Usage

    pca_biplot_plot(
      components = c(1, 2),
      points_to_label = "none",
      factor_name,
      scale_factor = 0.95,
      style = "points",
      label_features = FALSE,
      ...
    )

### Arguments

`components` | The principal components to plot (`numeric(2)`)
`points_to_label` | "none", "all", or "outliers" will be labelled on the plot.
`factor_name` | The sample_meta column name to use for colouring the points. You can provide up to two factors for this plot.
`scale_factor` | Scaling factor to apply to loadings. Default = 0.95.
`style` | Plot style for loadings. Can be 'points' (default) or 'arrows'.
`label_features` | 'Include feature labels from this variable meta column. Special keyword "rownames" will use the rownames of the variable_meta data.frame'
`...` | additional slots and values passed to struct_class

### Value

struct object

### Examples

    C = pca_biplot_plot(factor_name='Species')

[Package structToolbox version 1.0.1 Index]