TrueBreedingValue#

class pybrops.breed.prot.bv.TrueBreedingValue.TrueBreedingValue(gpmod, **kwargs)[source]#

Class implementing the extraction of true breeding value.

Constructor for the concrete class TrueBreedingValue.

Parameters:: gpmod (GenomicModel) – A true genomic prediction model from which to calculate true breeding values.

Methods

Estimate breeding values.

Attributes

Genomic prediction model.

estimate(ptobj, gtobj, miscout=None, **kwargs)[source]#

Estimate breeding values.

Parameters:

ptobj (BreedingValueMatrix, pandas.DataFrame, numpy.ndarray) – An object containing phenotype data. Must be a matrix of breeding values or a phenotype data frame.
gtobj (GenotypeMatrix, numpy.ndarray) – An object containing genotype data. Must be a matrix of genotype values.
miscout (dict, None) – Pointer to a dictionary for miscellaneous user defined output. If dict, write to dict (may overwrite previously defined fields). If None, user defined output is not calculated or stored.
gpmod (GenomicModel) – Genomic model used for predicting genotypes.
kwargs (dict) – Additional keyword arguments.

Returns:

out – A matrix of breeding values.

Return type:

BreedingValueMatrix