bigframes.pandas.DataFrame.align#
- DataFrame.align(other: DataFrame | Series, join: str = 'outer', axis: str | int | None = None) Tuple[DataFrame | Series, DataFrame | Series][source]#
Align two objects on their axes with the specified join method.
Join method is specified for each axis Index.
- Parameters:
join ({'outer', 'inner', 'left', 'right'}, default 'outer') – Type of alignment to be performed. left: use only keys from left frame, preserve key order. right: use only keys from right frame, preserve key order. outer: use union of keys from both frames, sort keys lexicographically. inner: use intersection of keys from both frames, preserve the order of the left keys.
axis (allowed axis of the other object, default None) – Align on index (0), columns (1), or both (None).
- Returns:
Aligned objects.
- Return type:
Tuple[bigframes.pandas.DataFrame or bigframes.pandas.Series, type of other]