Skip to content

Commit 3e499cf

Browse files
committed
minor readme edit
1 parent 60466a8 commit 3e499cf

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

README.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ for the fictional “Contoso” company. It includes various supporting
88
tables for business intelligence, such as customer, store, product, and
99
currency exchange data.
1010

11-
You can either load the datasets directly or use the function
12-
`create_contoso_duckdb()` to create a DuckDB database that contains the
13-
following tables:
11+
The package comes with the following datasets:
1412

1513
- **sales**:
1614
- Contains information about sales transactions, including the total
@@ -37,6 +35,10 @@ following tables:
3735
- Contains detailed line items for each order, including product key,
3836
quantity, and price for each item in the order.
3937

38+
You can either load the datasets directly or use the function
39+
`create_contoso_duckdb()` to create a DuckDB database that contains
40+
the following tables:
41+
4042
The Contoso dataset is a fictional set of data created by Microsoft. It
4143
is commonly used for educational and demonstration purposes to showcase
4244
various features of data analysis, business intelligence tools, and data
@@ -75,7 +77,7 @@ pak::pak("alejandrohagan/contoso")
7577

7678
## Example
7779

78-
This is a basic example which shows you how to solve a common problem:
80+
Example of how to create a duckdb database with Conotoso tables loaded
7981

8082
``` r
8183
library(contoso)
@@ -86,13 +88,3 @@ contoso_db <- create_contoso_duckdb(dir = "temp")
8688
# Access the sales dataset from the database
8789
sales_data <- contoso_db$sales
8890
```
89-
90-
## Features
91-
92-
- Realistic Sales Data: Simulates a variety of sales transactions,
93-
customer details, store locations, and product information.
94-
- Multiple Data Tables: Supports multiple tables like sales, customers,
95-
store details, product catalog, exchange rates, and time-series
96-
information.
97-
- Easy-to-Use: Load and use data directly or create a full DuckDB
98-
database for seamless analysis with create_contoso_database().

README.qmd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ pak::pak("alejandrohagan/contoso")
8484

8585
## Example
8686

87-
This is a basic example which shows you how to solve a common problem:
87+
Example of how to create a duckdb database with Conotoso tables loaded
88+
8889

8990
```{r}
9091
#| eval: false

0 commit comments

Comments
 (0)