TimeFrame.init_flag_column¶

TimeFrame.init_flag_column(flag_system, column_name=None, data=0)[source]¶

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

Parameters:

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 __flag__{flag_system} is used, with an integer suffix appended if the name already exists (e.g. __flag__CORE_FLAGS__1).
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