plot_allele_desc: Function to plot inheritance of alleles

View source: R/plot_allele_track.R

plot_allele_descR Documentation

Function to plot inheritance of alleles

Description

Function to plot inheritance of both alleles present at a locus in an individual from a gene_drop_object

Usage

plot_allele_desc(
  gene_drop_object,
  id,
  loci,
  col_sire = "#f1a340",
  col_dam = "#998ec3",
  line_trans = 0.6,
  point_trans = 1,
  focal_cex = 1.5,
  point_cex = 0.6,
  background = TRUE,
  cohort_labels = TRUE,
  id_labels = FALSE
)

Arguments

gene_drop_object

A gene_drop_object from gene-dropping

id

A numerical or character scalar of the focal ID to plot.

loci

A numeric scalar of the locus to plot.

col_sire

A character scalar determining the solid colour used for sires. Should be a colour name, integer, or hexadecimal string of the form "#rrggbb". The default is "#f1a340".

col_dam

A character scalar determining the solid colour used for dams. Should be a colour name, integer, or hexadecimal string of the form "#rrggbb". The default is "#998ec3".

line_trans

A numeric scalar between 0 and 1 determining the transparency of the plotted lines. The default is 0.6, setting to 0 hides the points.

point_trans

A numeric scalar between 0 and 1 determining the transparency of the plotted points. The default is 1, setting to 0 hides the points.

focal_cex

A numeric scalar determining the size of the point for the focal individual. The default is 1.5.

point_cex

A numeric scalar determining the size of the points used for the descendants. The default is 0.6, setting this value to 0 allows only the point of the focal individual to be plotted.

background

logical TRUE or FALSE. When TRUE the complete pedigree is plotted in light grey. Default is TRUE but disabling will make plotting much faster.

cohort_labels

logical TRUE or FALSE. When TRUE cohort labels are printed down the left-hand side. Default is TRUE.

id_labels

logical TRUE or FALSE. When TRUE id labels are printed above each point. Default is FASLE.


simplydch/GeneDrop documentation built on July 8, 2024, 8:17 p.m.