plot_genedrop: 'plot_genedrop()': Plot a summary graph of 'genedrop_...()'...

View source: R/genedrop_plot_functions.R

plot_genedropR Documentation

'plot_genedrop()': Plot a summary graph of 'genedrop_...()' outputs.

Description

'plot_genedrop()': Plot a summary graph of 'genedrop_...()' outputs.

Usage

plot_genedrop(
  genedrop_obj,
  analysis_to_plot = "all",
  sim_alpha = 0.3,
  obs_line_col = "red"
)

Arguments

genedrop_obj

Gene-Drop object

analysis_to_plot

Default = "all". Options are "frequency", "directional" and "cumulative". This will output graphs of allele frequency changes, directional change, and cumulative change. If the locus is multi-allelic and the user specifies the default option ("all"), the user will be prompted to press <Enter> to advance through each option.

sim_alpha

Default = 0.3. Alpha (transparency) value for plotted lines.

obs_line_col

Default = "red". Line colour to use for the observed data.

Value

plot of output from 'genedrop_...()' functions

Examples

data(unicorn)
genedrop_obj <- genedrop_snp(
  id = unicorn$id,
  mother = unicorn$mother,
  father = unicorn$father,
  cohort = unicorn$cohort,
  genotype = unicorn$Horns,
  nsim = 100,
  n_founder_cohorts = 4,
  fix_founders = TRUE,
  verbose = TRUE,
  interval = 10,
  resample_offspring = FALSE
)
plot_genedrop(genedrop_obj)

susjoh/genedroppeR documentation built on Sept. 9, 2024, 3:19 a.m.