plotScreeplot: Plot a screeplot

plotScreeplotR Documentation

Plot a screeplot

Description

Plots quality of clustering results suggested by kmeans with a screeplot.

Usage

plotScreeplot(object, ...)

## S4 method for signature 'Clustering'
plotScreeplot(
  object,
  methods_kmeans,
  ks = NULL,
  color = "steelblue",
  display_cols = TRUE,
  col_alpha = 0.9,
  col_color = "black",
  col_fill = "steelblue",
  display_line = TRUE,
  line_alpha = 0.9,
  line_color = "black",
  line_size = 1.5,
  display_points = TRUE,
  pt_alpha = 0.9,
  pt_color = "black",
  pt_size = 4.5
)

## S4 method for signature 'Analysis'
plotScreeplot(
  object,
  methods_kmeans = "Hartigan-Wong",
  ks = NULL,
  display_cols = TRUE,
  col_alpha = 0.9,
  col_color = "black",
  col_fill = "steelblue",
  display_line = TRUE,
  line_alpha = 0.9,
  line_color = "black",
  line_size = 1.5,
  display_points = TRUE,
  pt_alpha = 0.9,
  pt_color = "black",
  pt_size = 4.5
)

Arguments

object

Any object for whose class a method has been defined.

ks

Numeric vector. Denotes all options for k-clusters. Values <1 are discarded. Is converted into an integer vector.

Details

If ks and methods_kmeans are specified only the resulting combinations are included. Else all found combinations are included.

Value

A ggplot.


kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.