piper.verbs.rename_axis

piper.verbs.rename_axis(df: pandas.core.frame.DataFrame, *args, **kwargs)pandas.core.frame.DataFrame[source]

rename dataframe axis

This is a wrapper function rather than using e.g. df.rename_axis() For details of args, kwargs - see help(pd.DataFrame.rename_axis)

Examples

%%piper
sample_sales()
>> pivot_wider(index=['location', 'product'], values='target_sales')
>> reset_index()
>> head(tablefmt='plain')

    location    product       target_sales
 0  London      Beachwear            25478
 1  London      Footwear             25055
 2  London      Jeans                25906
 3  London      Sportswear           26671

%%piper
sample_sales()
>> pivot_wider(index=['location', 'product'], values='target_sales')
>> rename_axis(('AAA', 'BBB'), axis='rows')
>> head(tablefmt='plain')

    AAA     BBB           target_sales
 0  London  Beachwear            25478
 1  London  Footwear             25055
 2  London  Jeans                25906
 3  London  Sportswear           26671
Parameters
  • df – dataframe

  • *args – arguments for wrapped function

  • **kwargs – keyword-parameters for wrapped function

Returns

Return type

pandas DataFrame object