Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
farrandi committed Jan 27, 2024
1 parent e257dca commit f443f11
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center">
<img src="img/ttp_logo.png" width="350">
<img src="https://i.ibb.co/djVdtn9/ttp-logo.png" width="350">
</h1>

## 💪 Bringing the Power of tidyverse to Pandas!
Expand Down
2 changes: 1 addition & 1 deletion docs/example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Example usage\n",
"# Simple Example usage\n",
"\n",
"The `tidyversetopandas` package brings the familiar syntax of R's tidyverse to Python's pandas library, making it an invaluable tool for data scientists and analysts who are transitioning from R to Python. This documentation provides a real-life example demonstrating how to use the key functions of `tidyversetopandas`, including `mutate`, `filter`, `select`, and `arrange`.\n"
]
Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
```{include} ../README.md
```

```{toctree}
:maxdepth: 1
:hidden:
example.ipynb
tutorial.ipynb
changelog.md
contributing.md
conduct.md
autoapi/index
```
```
10 changes: 4 additions & 6 deletions docs/tutorial.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Tutorial: Analyzing the Palmer Penguins Dataset with `tidyversetopandas`\n",
"# Tutorial: Palmer Penguins Dataset\n",
"\n",
"In this tutorial, we will explore the Palmer Penguins dataset using the tidyversetopandas package. This package simplifies data manipulation in Python by bringing R's tidyverse-like functionality to pandas. We'll demonstrate how to use its key functions: `select`, `mutate`, `filter`, and `arrange`.\n"
]
Expand Down Expand Up @@ -269,8 +269,7 @@
],
"source": [
"print(newPenguins.shape)\n",
"newPenguins = ttp.filter(\n",
" newPenguins, \"species == 'Adelie' & body_mass_g > 3000\")\n",
"newPenguins = ttp.filter(newPenguins, \"species == 'Adelie' & body_mass_g > 3000\")\n",
"print(newPenguins.shape)"
]
},
Expand Down Expand Up @@ -1181,8 +1180,7 @@
}
],
"source": [
"penguins_small_bill = ttp.arrange(\n",
" penguins, True, \"bill_length_mm\", \"bill_depth_mm\")\n",
"penguins_small_bill = ttp.arrange(penguins, True, \"bill_length_mm\", \"bill_depth_mm\")\n",
"penguins_small_bill.head(1)"
]
},
Expand Down Expand Up @@ -1303,7 +1301,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.18"
"version": "3.11.7"
}
},
"nbformat": 4,
Expand Down

0 comments on commit f443f11

Please sign in to comment.