plotCommunityHulls: Adds convex hulls to each community to an existing plot

View source: R/plotCommunityHulls.R

plotCommunityHullsR Documentation

Adds convex hulls to each community to an existing plot

Description

This function loops over each community and plots the convex hull based on the centres of each of the groups that make up the community. See the demonstration scripts for example implementation.

Usage

plotCommunityHulls(
  siber,
  plot.args = list(col = 1, lty = 2),
  iso.order = c(1, 2),
  ...
)

Arguments

siber

a siber object as created by createSiberObject.R

plot.args

a list of plotting arguments with the following suggested, but non-exhaustive inputs. Additional plotting arguments for passing to the internal call to graphics::plot() can either be specified here, or as additional arguments under the ... method.

  • col the color of the lines of the convex hull. See graphics::lines() for more details.

  • lty the line type of the convex hull.See graphics::lines() for more details.

  • lwd the line width of the convex hulls. See graphics::lines() for more details.

iso.order

a vector of length 2, either c(1,2) or c(2,1). The order determines which of the columns of raw data are plotted on the x (1) or y (2) axis. N.B. this will be deprecated in a future release, and plotting order will be achieved at point of data-entry.

...

additional arguments for passing to graphics::plot().

Value

Convex hulls, drawn as lines on an existing figure.


SIBER documentation built on Oct. 19, 2023, 5:09 p.m.