Skip to content

Commit f7035ca

Browse files
committed
Add to load_dataset() docstring
1 parent 2eab0de commit f7035ca

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

pointblank/validate.py

+17
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,8 @@ def load_dataset(
161161
- `game_revenue`: A dataset with 2000 rows and 11 columns. Provides revenue data for a game
162162
development company. For the particular game, there are records of player sessions, the items
163163
they purchased, ads viewed, and the revenue generated.
164+
- `nycflights`: A dataset with 336,776 rows and 18 columns. This dataset provides information
165+
about flights departing from New York City airports (JFK, LGA, or EWR) in 2013.
164166
165167
Supported DataFrame Types
166168
-------------------------
@@ -199,6 +201,21 @@ def load_dataset(
199201
200202
The `game_revenue` dataset is a more real-world dataset with a mix of data types, and it's
201203
significantly larger than the `small_table` dataset at 2000 rows and 11 columns.
204+
205+
The `nycflights` dataset can be loaded as a DuckDB table by specifying the dataset name and
206+
setting `tbl_type="duckdb"`:
207+
208+
```{python}
209+
import pointblank as pb
210+
211+
nycflights = pb.load_dataset(dataset="nycflights", tbl_type="duckdb")
212+
213+
pb.preview(nycflights)
214+
```
215+
216+
The `nycflights` dataset is a large dataset with 336,776 rows and 18 columns. This dataset is
217+
truly a real-world dataset and provides information about flights originating from New York
218+
City airports in 2013.
202219
"""
203220

204221
# Raise an error if the dataset is from the list of provided datasets

0 commit comments

Comments
 (0)