iode.Equation.sample

property Equation.sample: Sample

Estimation sample of the current equation.

Parameters:

value: str or Sample

New estimation sample

Examples

>>> from iode import Equation, variables
>>> variables.clear()
>>> variables.sample
None
>>> eq_ACAF = Equation("ACAF", "(ACAF / VAF[-1]) := acaf1 + acaf2 * GOSF[-1] + acaf4 * (TIME=1995)")
>>> eq_ACAF.sample
None

>>> # set Variables sample
>>> variables.sample = "1960Y1:2015Y1"
>>> variables.sample
Sample("1960Y1:2015Y1")

>>> # specify starting and ending periods
>>> eq_ACAF.sample = "1980Y1:2000Y1"
>>> eq_ACAF.sample
Sample("1980Y1:2000Y1")

>>> # specify only the starting period 
>>> # -> ending period = ending period of the Variables sample
>>> eq_ACAF.sample = "1990Y1:"
>>> eq_ACAF.sample
Sample("1990Y1:2015Y1")

>>> # specify only the ending period 
>>> # -> starting period = starting period of the Variables sample
>>> eq_ACAF.sample = ":2010Y1"
>>> eq_ACAF.sample
Sample("1960Y1:2010Y1")

>>> # specify nothing -> reset the sample
>>> eq_ACAF.sample = ":"
>>> eq_ACAF.sample
None