State.tracing.trace_df#

State.tracing.trace_df(df: DataFrame, label: str, slicer=None, columns: Optional[list[str]] = None, index_label=None, column_labels=None, transpose=True, warn_if_empty=False)#

Slice dataframe by traced household or person id dataframe and write to CSV

Parameters:
state: workflow.State
df: pandas.DataFrame

traced dataframe

label: str

tracer name

slicer: Object

slicer for subsetting

columns: list

columns to write

index_label: str

index name

column_labels: [str, str]

labels for columns in csv

transpose: boolean

whether to transpose file for legibility

warn_if_empty: boolean

write warning if sliced df is empty

Returns:
Nothing