TimeFrame.init_flag_column

TimeFrame.init_flag_column(base, flag_system, column_name=None, data=0)

Add a new column to the TimeFrame DataFrame, setting it as a Flag Column.

Parameters:

• base (str) – Name of the value/data column this flag column will refer to.

• flag_system (str) – The name of the flag system.

• column_name (str | None) – Optional name for the new flag column. If omitted, a name of the form “{base}__flag__{flag_system}” is used.

• data (Union[int, Sequence[int]]) – The default value to populate the flag column with. Can be a scalar or list-like. Defaults to 0.

Return type:

None