Added join examples and doc

2025-02-13 15:14:55 -08:00
parent dcd0122df0
commit 3893bdbdf5
10 changed files with 68 additions and 2 deletions
@@ -50,7 +50,7 @@ Note: GPU is not required to run this custom module.
 5. Start ComfyUI.

 ### Troubleshooting for installation
-This custom node module requires pandas and matplotlib, which are not included in the default ComfyUI installation. If you install this module using ComfyUI Manager, these packages should be installed automatically. However, if the installation fails, refer to the pandas and matplotlib documentation for manual installation.
+This custom node module requires pandas and matplotlib, which are not included in the default ComfyUI installation. If you install this module using ComfyUI Manager, these packages should be installed automatically. However, if installation fails, refer to the pandas and matplotlib documentation for manual installation.

 ## How to Use
 Refer to [User's Guide](docs/ug.md)
@@ -40,8 +40,29 @@ Use **Pandas Select Columns** for selecting columns, **Pandas Select Rows** to s

 ![Pandas select subset](images/subset.jpg)

-## Joining DataFrames.
+## Joining DataFrames
 Use **Pandas Join**.  You can select from inner, left, right, outer joins.
+First, use two **Pandas Load CSV** nodes to load two CSVs for the left DataFrame and right DataFrame.
+
+![Load two CSVs into DataFrames](images/join_data_load.png)
+
+### Inner join
+Specify the common column in the "on column name" field, and set the join method to **inner** in the **Pandas Join** node.
+![Inner join](images/inner_join.png)
+
+### Left join
+Specify the common column in the "on column name" field, and set the join method to **left** in the **Pandas Join** node.
+![Left join](images/left_join.png)
+
+### Right join
+Specify the common column in the "on column name" field, and set the join method to **right** in the **Pandas Join** node.
+![Right join](images/right_join.png)
+
+### Outer join
+Specify the common column in the "on column name" field, and set the join method to **outer** in the **Pandas Join** node.
+![Outer join](images/outer_join.png)
+
+The workflow file examples/workflows/join.json contains all of the above cases.

 ## Extract the first few rows
 Use **Pandas Head**.
@@ -62,6 +83,8 @@ Use **Pandas To String**. This node is to convert the DataFrame to a displayable

 ## Displaying charts or plots
 Use one of the below:
+| Node | Purpose |
+|---|---|
 | **MPL Bar Chart**       | Generate a bar chart               |
 | **MPL Line Plot**       | Generate a line plot               |
 | **MPL Scatter Plot**    | Generate a scatter plot            |
@@ -0,0 +1,21 @@
+Name,ActorID
+Barron Sawyer, 1
+Elara Whitmore, 2
+Jaxon Vance, 3
+Seraphina Lowell, 4
+Dorian Kessler, 5
+Valeria Knox, 6
+Orin Mercer, 7
+Celeste Draven, 8
+Lucian Hartwell, 9
+Marisol Quinn, 10
+Felix Holloway, 11
+Rowan Sinclair, 12
+Sienna Wren, 13
+Cassius Vale, 14
+Livia Monroe, 15
+Gideon Thorne, 16
+Zara Fontaine, 17
+Maverick Calloway, 18
+Isolde Mercer, 19
+Ronan Delacroix, 20
@@ -0,0 +1,21 @@
+Title,MovieID,ActorID
+Shadow Circuit, 1, 5
+The Last Ember, 2, 4
+Echoes of Orion, 3, 3
+Neon Revenant, 4, 2
+Fractured Horizon, 5, 1
+Blood and Chrome, 6, 10
+The Silent Epoch, 7, 9
+Ashes of Tomorrow, 8, 8
+Hyperion’s Wake, 9, 7
+Obsidian Mirage, 10, 6
+The Hollow Accord, 11, 5
+Lunar Divide, 12, 3
+Redshift Paradox, 13, 1
+Phantom Genesis, 14, 4
+Vanishing Point Protocol, 15, 2
+Nocturne Zero, 16,
+Polaris Run, 17,
+The Gilded Warden, 18,
+Aetherfall, 19,
+Terminal Sanctum, 20,