Merge pull request #67 from UBC-MDS/final_changes

fixed a small grammatical error
UBC-MDS · Jan 26, 2025 · 1627b7c · 1627b7c
2 parents 76f0d1f + 2443017
commit 1627b7c
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 65 deletions.
diff --git a/docs/example.ipynb b/docs/example.ipynb
diff --git a/docs/summarize.ipynb b/docs/summarize.ipynb
@@ -20,7 +20,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Imagine you are working on a data science problem and you have got a dataset that you should extract interesting patterns from. The time is limited, thus you think of a convenient function that could the initial exploratory data analysis for you - generate a quick summary of the dataset at hand. It could then compile the information into a well-organized PDF report, complete with charts and tables, enabling the team to quickly grasp trends and have a quick discussion - all without needing to manually process the data. \n",
+    "Imagine you are working on a data science problem and you have got a dataset that you should extract interesting patterns from. The time is limited, thus you think of a convenient function that could do the initial exploratory data analysis for you — generate a quick summary of the dataset at hand. It could then compile the information into a well-organized PDF report, complete with charts and tables, enabling the team to quickly grasp trends and have a quick discussion — all without the need to manually process the data. \n",
     "\n",
     "Situations like this call for the function `summarize` from the `summarease` package."
    ]
@@ -96,7 +96,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Importing the necessary functions and libraries"
+    "### Importing the necessary functions and libraries"
    ]
   },
   {
@@ -113,7 +113,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Step 1 - Load the dataset"
+    "### Step 1 - Load the dataset"
    ]
   },
   {
@@ -246,7 +246,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Step 2 - Prepare the dataset information (optional)"
+    "### Step 2 - Prepare the dataset information (optional)"
    ]
   },
   {
@@ -274,7 +274,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Step 3 - Run the summarize function"
+    "### Step 3 - Run the summarize function"
    ]
   },
   {
@@ -288,7 +288,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "##### Using plots"
+    "#### Using plots"
    ]
   },
   {
@@ -328,7 +328,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "##### Using tables"
+    "#### Using tables"
    ]
   },
   {

diff --git a/docs/summarize_dtypes.ipynb b/docs/summarize_dtypes.ipynb
@@ -29,9 +29,13 @@
     "\n",
     "### Function Output\n",
     "\n",
-    "The function returns a pandas DataFrame summarizing the counts of each data type in the dataset.\n",
-    "\n",
-    "\n",
+    "The function returns a pandas DataFrame summarizing the counts of each data type in the dataset."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
     "## Necessary libraries\n",
     "\n",
     "To use the `summarize_dtypes_table` function, ensure the following libraries are installed:"

diff --git a/docs/summarize_numeric.ipynb b/docs/summarize_numeric.ipynb
@@ -48,7 +48,7 @@
     "\n",
     "We'll use the following dataset to demonstrate the module's functionality:\n",
     "\n",
-    "#### Dataset: Numeric Data"
+    "### Dataset: Numeric Data"
    ]
   },
   {
@@ -70,15 +70,15 @@
    "source": [
     "## Example usage\n",
     "\n",
-    "#### `summarize_numeric`\n",
+    "### `summarize_numeric`\n",
     "\n",
     "This function calculates summary statistics or generates visualizations for numeric columns. It takes two parameters:\n",
     "\n",
     "\n",
     "- `dataset`: The input dataset containing numeric variables. It must be a DataFrame.\n",
     "- `summarize_by`: Specifies the format for summarizing the numeric variables. It can be either `\"table\"` (default) to generate a summary table, or `\"plot\"` to generate visualizations like density plots and a correlation heatmap.\n",
     "\n",
-    "##### Example 1: Summarizing with a Table"
+    "#### Example 1: Summarizing with a Table"
    ]
   },
   {
@@ -192,7 +192,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "##### Example 2: Visualizing Numeric Relationships"
+    "#### Example 2: Visualizing Numeric Relationships"
    ]
   },
   {

diff --git a/docs/summarize_target.ipynb b/docs/summarize_target.ipynb
@@ -42,11 +42,11 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Example dataset\n",
+    "## Example datasets\n",
     "\n",
     "We'll use the following datasets to demonstrate the module's functionality:\n",
     "\n",
-    "#### Dataset 1: Categorical Target Dataset"
+    "### Dataset 1: Categorical Target Dataset"
    ]
   },
   {
@@ -64,7 +64,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "#### Dataset 2: Numerical Target Dataset"
+    "### Dataset 2: Numerical Target Dataset"
    ]
   },
   {
@@ -100,7 +100,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "##### Example 1: Summarizing a Categorical Target using a table"
+    "#### Example 1: Summarizing a Categorical Target using a table"
    ]
   },
   {
@@ -196,7 +196,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "##### Example 2: Summarizing a Numerical Target"
+    "#### Example 2: Summarizing a Numerical Target"
    ]
   },
   {
@@ -289,7 +289,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "##### Example: Visualizing Class Balance"
+    "#### Example 3: Visualizing Class Balance"
    ]
   },
   {