oscar_colony.optimise.surplus_summary.SurplusSummary#

class oscar_colony.optimise.surplus_summary.SurplusSummary(total_n=0, total_n_surplus=0, surplus_per_genotype=<factory>)[source]#

Summary of surplus across all genotypes

__init__(total_n=0, total_n_surplus=0, surplus_per_genotype=<factory>)#

Methods

__init__([total_n, total_n_surplus, ...])

create_genotype_df([decimal_places])

Create a pandas dataframe from surplus_per_genotype.

Attributes

total_n

total_n_surplus

surplus_per_genotype

create_genotype_df(decimal_places=None)[source]#

Create a pandas dataframe from surplus_per_genotype.

Columns are: ‘Genotype’, ‘Required N’, ‘Total N’, ‘Total N Surplus’ and ‘Percent Surplus’

Parameters:

decimal_places (int | None) – Number of decimal places to round float values to

Returns:

DataFrame summarising totals and surplus per genotype

Return type:

DataFrame