add_interrupt: A ggproto for annotating the interrupted path

In ferrn: Facilitate Exploration of touRR optimisatioN

A ggproto for annotating the interrupted path

Description

This is a wrapper function used by explore_space_pca() and should be be called directly by the user

Usage

add_interrupt(
  dt,
  interrupt_size = 0.5,
  interrupt_alpha = NULL,
  interrupt_color = NULL,
  interrupt_group = NULL,
  interrupt_linetype = "dashed",
  ...
)

Arguments

dt	A data object from the running the optimisation algorithm in guided tour
interrupt_size	numeric; the size of the interruption path
interrupt_alpha	numeric; the alpha of the interruption path
interrupt_color	the variable to be coloured by
interrupt_group	the variable to label different interruption
interrupt_linetype	character; the linetype to annotate the interruption
...	other aesthetics inherent from explore_space_pca()

Value

a wrapper for annotating the interruption in explore_space_pca()

See Also

Other draw functions: add_anchor(), add_anno(), add_dir_search(), add_end(), add_interp_last(), add_interp(), add_search(), add_space(), add_start(), add_theo()

ferrn documentation built on Aug. 6, 2022, 5:08 p.m.