simgraph_graph: Simple kin dispersal simulation for graphical display....

Description Usage Arguments Value See Also Examples

View source: R/simgraph_graph.R

Description

Simple kin dispersal simulation for graphical display. (graphs the pre-existing simulation).

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
simgraph_graph(
  result,
  nsims = 10,
  labls = TRUE,
  steps = TRUE,
  moves = TRUE,
  shadows = TRUE,
  kinship = NULL,
  show_area = TRUE,
  centred = FALSE,
  pinwheel = FALSE,
  scattered = FALSE,
  lengths = TRUE,
  lengthlabs = TRUE,
  histogram = FALSE,
  binwidth = posigma/5,
  freqpoly = FALSE
)

Arguments

result

simulation supplied from simgraph_data() function (tibble)

nsims

number of families to graph

labls

Logical. Displays labels.

steps

Logical. Whether or not to show any details of dispersal movement

moves

Logical. Whether or not to show (curved) lines denoting dispersal movement

shadows

Logical. Whether or not to show (dashed) shadows tracing dispersal movement.

kinship

Character. Lists the kin category the simulation is reconstructing. One of "PO", "FS", "HS", "AV", "GG", "HAV", "GGG", "1C", "1C1", "2C", "GAV" (no half-categoris included)

show_area

Logical. Whether or not to show the parental seed area as defined in data$dims

centred

Logical. Whether or not to centre the coordinates on one individual.

pinwheel

Logical. Whether the final graph should be of the pinwheel form.

scattered

Logical. Whether the final graph should be of the scatter form.

lengths

Logical. Whether or not to show a dashed line connecting the 'focus' kin to illustrate overall distance of dispersal.

lengthlabs

Logical. Whether to show labels denoting distance of dispersal between focus kin.

histogram

Logical. Whether the final graph should be of the histogram form.

binwidth

Numeric. Binwidth for histogram or freqpoly.

freqpoly

Logical. Whether the final graph should be of the freqpoly form.

Value

1
 Returns a ggplot object for graphing.

See Also

Other simgraph: simgraph_data()

Examples

1
2
simdata <- simgraph_data()
simgraph_graph(simdata)

kindisperse documentation built on July 28, 2021, 5:09 p.m.