BreedingValueProtocol

class pybrops.breed.prot.bv.BreedingValueProtocol.BreedingValueProtocol

Bases: object

Abstract class defining interfaces for breeding value calculation protocols.

The purpose of this abstract class is to provide functionality for:

1. Estimation of breeding values from phenotype values.

Methods

estimate

Estimate breeding values.

abstract estimate(ptobj, gtobj, miscout, **kwargs)

Estimate breeding values.

Parameters:

• ptobj (pandas.DataFrame) – An object containing phenotype data. Must be a phenotype data frame.

• gtobj (GenotypeMatrix) – An object containing genotype data. Must be a genotype matrix.

• 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.

• kwargs (dict) – Additional keyword arguments.

Returns:

out – A matrix of breeding values.

Return type:

BreedingValueMatrix