docs(eda): added target analysis description to docstrings and eda docs

Author: Devin Lu

dataprep/eda/create_diff_report/__init__.py

@@ -36,6 +36,8 @@ def create_diff_report(
     ----------
     df_list
         The DataFrames for which data are calculated.
+    target
+        Target feature to be compared against all other columns.
     config
         A dictionary for configuring the visualizations
         E.g. config={"hist.bins": 20}

dataprep/eda/create_diff_report/diff_formatter.py

@@ -84,6 +84,8 @@ def format_diff_report(
         Currently only the 'basic' is fully implemented.
     progress
         Whether to show the progress bar.
+    target
+        Target feature to be compared against all other columns.
 
     Returns
     -------
@@ -122,6 +124,13 @@ def format_diff_report(
 def validate_target(target: str, df_list: List[pd.DataFrame]):
     """
     Helper function, verify that target column exists
+
+    Parameters
+    ----------
+    target
+        Target feature to be compared against all other columns.
+    df_list
+        The Dataframe for which data are calculated.
     """
     exists = False
     for df in df_list:
@@ -140,6 +149,8 @@ def format_basic(df_list: List[pd.DataFrame], target: Optional[str], cfg: Config
     ----------
     df_list
         The DataFrames for which data are calculated.
+    target
+        Target feature to be compared against all other columns.
     cfg
         The config dict user passed in. E.g. config =  {"hist.bins": 20}
         Without user's specifications, the default is "auto"
@@ -242,6 +253,8 @@ def compute_plot_data(
         E.g.  dtype = {"a": Continuous, "b": "Nominal"} or
         dtype = {"a": Continuous(), "b": "nominal"}
         or dtype = Continuous() or dtype = "Continuous" or dtype = Continuous()
+    target
+        Target feature to be compared against all other columns.
     """
     # pylint: disable=too-many-branches, too-many-locals
 

docs/source/user_guide/eda/create_diff_report.ipynb

@@ -81,6 +81,32 @@
    "source": [
     "create_diff_report({\"df_train\": df_train, \"df_test\": df_test})"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "b15f40d6",
+   "metadata": {},
+   "source": [
+    "## Target Feature Analysis"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "a79fe776",
+   "metadata": {},
+   "source": [
+    "Users can also pass in a target column to compare how the feature relates to all other features in both dataframes."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "8d6bed85",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "create_diff_report([df_train, df_test], target='LotArea')"
+   ]
   }
  ],
  "metadata": {