SummarySeq {sequoia} | R Documentation |
Summarise Sequoia Output or Pedigree
Description
Number of assigned parents and grandparents and sibship sizes, split by genotyped, dummy, and 'observed'.
Usage
SummarySeq(
SeqList = NULL,
Pedigree = NULL,
DumPrefix = c("F0", "M0"),
SNPd = NULL,
Plot = TRUE,
Panels = "all"
)
Arguments
SeqList |
the list returned by |
Pedigree |
dataframe, pedigree with the first three columns being id - dam - sire. Column names are ignored, as are additional columns, except for columns OHdam, OHsire, MEpair, LLRdam, LLRsire, LLRpair (plotting only). |
DumPrefix |
character vector of length 2 with prefixes for dummy dams
(mothers) and sires (fathers). Will be read from |
SNPd |
character vector with ids of SNP genotyped individuals. Only used
when |
Plot |
show barplots and histograms of the results, as well as of the parental LLRs, Mendelian errors, and agepriors, if present. |
Panels |
character vector with panel(s) to plot. Choose from 'all', 'G.parents' (parents of genotyped individuals), 'D.parents' (parents of dummy individuals), 'sibships' (distribution of sibship sizes), 'LLR' (log10-likelihood ratio parent/otherwise related), 'OH' (count of opposite homozygote SNPs). |
Value
A list with the following elements:
PedSummary |
a 2-column matrix with basic summary statistics, similar
to what used to be returned by Pedantics' |
ParentCount |
an array with the number of assigned parents, split by:
|
GPCount |
an array with the number of assigned grandparents, split by:
|
SibSize |
a list with elements 'mat' (maternal half + full siblings), 'pat' (paternal half + full siblings), and 'full' (full siblings). Each is a matrix with a number of rows equal to the maximum sibship size, and 3 columns, splitting by the type of parent: Genotyped, Dummy, or Observed. |
See Also
PlotSeqSum
to plot the output of this function;
sequoia
for pedigree reconstruction and links to other
functions.
Examples
SummarySeq(Ped_griffin)
sumry_grif <- SummarySeq(SeqOUT_griffin, Panels=c("G.parents", "OH"))
sumry_grif$PedSummary