Skip to content

Commit 9fb429c

Browse files
committed
add example code for conditional_join
1 parent 12f70f3 commit 9fb429c

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

janitor/functions.py

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6305,6 +6305,39 @@ def conditional_join(
63056305
63066306
Only `inner`, `left`, and `right` joins are supported.
63076307
6308+
Functional usage syntax:
6309+
6310+
.. code-block:: python
6311+
6312+
import pandas as pd
6313+
import janitor as jn
6314+
6315+
df = pd.DataFrame(...)
6316+
right = pd.DataFrame(...)
6317+
6318+
df = jn.conditional_join(
6319+
df,
6320+
right,
6321+
(col_from_df, col_from_right, join_operator),
6322+
(col_from_df, col_from_right, join_operator),
6323+
...,
6324+
how = 'inner' # or left/right
6325+
sort_by_appearance = True # or False
6326+
)
6327+
6328+
Method chaining syntax:
6329+
6330+
.. code-block:: python
6331+
6332+
df.conditional_join(
6333+
right,
6334+
(col_from_df, col_from_right, join_operator),
6335+
(col_from_df, col_from_right, join_operator),
6336+
...,
6337+
how = 'inner' # or left/right
6338+
sort_by_appearance = True # or False
6339+
)
6340+
63086341
63096342
:param df: A Pandas DataFrame.
63106343
:param right: Named Series or DataFrame to join to.

0 commit comments

Comments
 (0)