From e852259857eb740be7cdaa9aa402080b8565c401 Mon Sep 17 00:00:00 2001 From: d33bs Date: Wed, 10 Jan 2024 13:46:29 -0700 Subject: [PATCH] add further clarity surrounding merge and join --- docs/source/overview.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/overview.md b/docs/source/overview.md index 5425fbb2..987472ed 100644 --- a/docs/source/overview.md +++ b/docs/source/overview.md @@ -254,3 +254,6 @@ The word "join" here is interpreted through `SQL-based terminology on joins `_ through :code:`convert(..., joins="SELECT * FROM ... JOIN ...", ...)` (:mod:`convert() `). Also see CytoTable's presets found here: :data:`presets.config ` or via `GitHub source code for presets.config `_. ``` + +Note: data software outside of CytoTable sometimes makes use of the term "merge" to describe capabilities which are similar to join (for ex. [`pandas.DataFrame.merge`](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.merge.html). +Within CytoTable, we opt to describe these operations with "join" to avoid confusion with software development alongside the technologies used (for ex. [DuckDB SQL](https://duckdb.org/docs/archive/0.9.2/sql/introduction) includes no `MERGE` keyword).