Learn R Programming

nprcgenekeepr (version 3.0.0)

summary.nprcgenekeeprErr: Summarize a studbook quality-control error list

Description

Summarizes either a studbook quality-control error list (class nprcgenekeeprErr) or a genetic value report (class nprcgenekeeprGV); this page covers both methods.

Usage

# S3 method for nprcgenekeeprErr
summary(object, ...)

# S3 method for nprcgenekeeprGV summary(object, ...)

Value

For an error list, an object of class summary.nprcgenekeeprErr. It is a list with the elements txt (a character string describing the problems found) and sp (the data frame of suspicious parents).

For a genetic value report, a character vector of class summary.nprcgenekeeprGV

Arguments

object

object of class nprcgenekeeprErr or nprcgenekeeprGV

...

currently unused by either method

Examples

Run this code
errorList <- qcStudbook(nprcgenekeepr::pedOne,
  minSireAge = 0,
  minDamAge = 0,
  reportChanges = TRUE,
  reportErrors = TRUE
)
summary(errorList)
examplePedigree <- nprcgenekeepr::examplePedigree
breederPed <- qcStudbook(examplePedigree,
  minSireAge = 2L,
  minDamAge = 2L,
  reportChanges = FALSE,
  reportErrors = FALSE
)
focalAnimals <- breederPed$id[!(is.na(breederPed$sire) &
  is.na(breederPed$dam)) &
  is.na(breederPed$exit)]
ped <- setPopulation(ped = breederPed, ids = focalAnimals)
trimmedPed <- trimPedigree(focalAnimals, breederPed)
probands <- ped$id[ped$population]
ped <- trimPedigree(probands, ped,
  removeUninformative = FALSE,
  addBackParents = FALSE
)
geneticValue <- reportGV(ped,
  guIter = 50L, # should be >= 1000L
  guThresh = 3L,
  byID = TRUE,
  updateProgress = NULL
)
trimmedGeneticValue <- reportGV(trimmedPed,
  guIter = 50L, # should be >= 1000L
  guThresh = 3L,
  byID = TRUE,
  updateProgress = NULL
)
summary(geneticValue)
summary(trimmedGeneticValue)

Run the code above in your browser using DataLab