importdta.get_var_labels

importdta.get_var_labels(df, *, include_defaults=False)

Get variable labels for a DataFrame.

Reads df.attrs[‘variable_labels’] and optionally fills missing labels from MTable.DEFAULT_LABELS.

Parameters

Name Type Description Default
df pandas.DataFrame DataFrame to inspect. required
include_defaults bool If True, add labels from MTable.DEFAULT_LABELS for columns missing a label. False

Returns

Name Type Description
dict Mapping {column_name: label}.

Examples

>>> get_var_labels(df)
>>> get_var_labels(df, include_defaults=True)