cl_plot: Plot a CrossLink object

View source: R/crosslink.R

cl_plotR Documentation

Plot a CrossLink object

Description

Plot a CrossLink object

Usage

cl_plot(
  object,
  layout = NULL,
  link = NULL,
  cross = NULL,
  label = NULL,
  header = NULL,
  add = NULL,
  annotation = cl_annotation()
)

Arguments

object

a CrossLink object

layout

the layout to be plot. Set NULL to plot current active layout

link

a named list of arguments for links. see ggplot2::geom_segment(). Set NULL to use default settings, or Set NA to not show.

cross

a named list of arguments for crosses. see ggplot2::geom_point(). Set NULL to use default settings, or Set NA to not show.

label

a named list of arguments for node labels. see ggplot2::geom_text(). Set NULL to use default settings, or Set NA to not show.

header

a named list of arguments for headers. see ggplot2::geom_text(). Set NULL to use default settings, or Set NA to not show.

add

other gg objects to be added to final plot, such as theme(). use list of multiple gg objects to add them all.

annotation

generated by cl_annotation()

Details

For link, cross, label, header: "geom" is restricted for setting geom function, such as list(geom = "arc") for link.

Value

a ggplot2 object


zzwch/crosslink documentation built on Aug. 27, 2023, 5:57 p.m.