tsa.formula#

mainsource.formula(name, display=True, expanded=False, remote=True, level=-1)#

Get the formula associated with a name.

tsa.formula('sales.eu')
...
'(add (series "sales.fr") (series "sales.be"))')

Expanding means replacing all series expressions that are formulas with the formula contents.

It can be all-or-nothing with the expanded parameter or asked for a defined level (stopping the expansion process).

The maximum level can be obtained through the formula_depth api call.

Parameters:

  • name (str)

  • display (bool)

  • expanded (bool)

  • remote (bool)

  • level (int)

Return type:

str | None