pandas.MultiIndex.to_hierarchical

MultiIndex.to_hierarchical(self, n_repeat, n_shuffle=1)[source]

Return a MultiIndex reshaped to conform to the shapes given by n_repeat and n_shuffle.

Deprecated since version 0.24.0.

Useful to replicate and rearrange a MultiIndex for combination with another Index with n_repeat items.

Parameters:
n_repeat : int

Number of times to repeat the labels on self

n_shuffle : int

Controls the reordering of the labels. If the result is going to be an inner level in a MultiIndex, n_shuffle will need to be greater than one. The size of each label must divisible by n_shuffle.

Returns:
MultiIndex

Examples

>>> idx = pd.MultiIndex.from_tuples([(1, 'one'), (1, 'two'),
                                    (2, 'one'), (2, 'two')])
>>> idx.to_hierarchical(3)
MultiIndex(levels=[[1, 2], ['one', 'two']],
           codes=[[0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1],
                  [0, 0, 0, 1, 1, 1, 0, 0, 0, 1, 1, 1]])
Scroll To Top