Result

class Result(name=None, npts=None, scale=True, color=None, n_rows=0, n_copies=0)

Bases: object

Stores a single result – by default, acts like an array.

Parameters:

• name (str) – name of this result, e.g. new_infections

• npts (int) – if values is None, precreate it to be of this length

• scale (bool) – whether or not the value scales by population scale factor

• color (str/arr) – default color for plotting (hex or RGB notation)

Example:

import hpvsim as hpv
r1 = hpv.Result(name='test1', npts=10)
r1[:5] = 20
print(r1.values)

Attributes

npts
shape

Methods

sum()

To allow result.sum() instead of result.values.sum()

mean()

To allow result.mean() instead of result.values.mean()

median()

To allow result.median() instead of result.values.median()