fixed #11, #10

Author: usrbinr

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown.yaml
+
+permissions: read-all
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -9,3 +9,4 @@ README.qmd
 README.html
 /README_files/*
 renv.lock
+docs

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: contoso
 Type: Package
-Title: The Contoso Dataset
+Title: Dataset of the 'Contoso' Company
 Version: 1.0.0
 Authors@R: c(
     person(
@@ -9,27 +9,28 @@ Authors@R: c(
       role = c("aut", "cre")
     )
   )
-Description: This package provides access to a made-up dataset simulating sales transactions from the fictional "Contoso" company. The dataset includes various related tables that contain essential business and operational data, useful for analyzing sales performance and other business insights. Key tables included in the package are:
+Description: A collection of synthetic datasets simulating sales transactions from a fictional company. The dataset includes various related tables that contain essential business and operational data, useful for analyzing sales performance and other business insights. Key tables included in the package are:
   - "sales": Contains data on individual sales transactions, including order details, pricing, quantities, and customer information.
   - "customer": Stores customer-specific details such as demographics, geographic location, occupation, and birthday.
   - "store": Provides information about stores, including location, size, status, and operational dates.
   - "orders": Contains details about customer orders, including order and delivery dates, store, and customer data.
-  - "orderrows": Provides detailed information about each item in an order, including product, quantity, pricing, and cost.
   - "product": Contains data on products, including attributes such as product name, category, price, cost, and weight.
-  - "fx": Foreign exchange data with exchange rates for different currencies used in the sales transactions.
   - "date": A time-based table that includes date-related attributes like year, month, quarter, day, and working day indicators.
   This dataset is ideal for practicing data analysis, performing time-series analysis, creating reports, or simulating business intelligence scenarios.
 License: MIT + file LICENSE
 Imports:
     DBI,
     dplyr,
-    duckdb
+    cli,
+    duckdb (>= 1.4.0)
 Suggests:
     testthat (>= 3.0.0)
 Encoding: UTF-8
 LazyData: true
 RoxygenNote: 7.3.2
+Roxygen: list(markdown = TRUE)
 Depends: 
     R (>= 3.5)
-URL: https://usrbinr.github.io/contoso/
+URL: https://usrbinr.github.io/contoso/, https://github.com/usrbinr/contoso
 Config/testthat/edition: 3
+BugReports: https://github.com/usrbinr/contoso/issues

NAMESPACE

@@ -1,3 +1,4 @@
 # Generated by roxygen2: do not edit by hand
 
 export(create_contoso_duckdb)
+export(launch_ui)

NEWS.md

@@ -1,3 +1,9 @@
+# contoso 1.1.0
+* launch_ui function added
+* pkgdown instead of altdocs
+* new logo
+
+
 # contoso 1.0.0
 
 * Support for 100M row database now supported

R/database.R

@@ -14,6 +14,7 @@
 #' - `store`: Contains information about store locations and attributes.
 #' - `fx`: Contains foreign exchange rate data for currency conversion.
 #' - `date`: Contains various date-related information, including day, week, month, and year.
+#' - `con`: the duckdb connection to your database
 #'
 #' You can choose to store the database in memory or in a temporary directory. If you choose "temp", the database will be created in a temporary file on disk. If you choose "in_memory", the database will be created entirely in memory and will be discarded after the R session ends.
 #'
@@ -54,10 +55,9 @@ create_contoso_duckdb <- function(db_dir= c("in_memory"),size="100K"){
 
   #attach motherduck database
 
-  suppressWarnings(DBI::dbExecute(con,"INSTALL motherduck;"))
-
-  suppressWarnings(DBI::dbExecute(con,"ATTACH 'md:_share/contoso/5cd50a2d-d482-4160-b260-f10091290db9' as contoso"))
+suppressWarnings(DBI::dbExecute(con,"INSTALL motherduck;"))
 
+suppressWarnings(DBI::dbExecute(con,"ATTACH 'md:_share/contoso/5cd50a2d-d482-4160-b260-f10091290db9' as contoso"))
 
 tables_vec <- c("sales","product","customer","store","orders","orderrows","fx","date")
 
@@ -92,9 +92,76 @@ out <- list(
   ,date=date_db
   ,orders=orders_db
   ,orderrows=orderrows_db
+  ,con=con
 )
 
 
 
 return(out)
 }
+
+
+
+
+
+#' @title Launch the DuckDB UI in your browser
+#'
+#' @name launch_ui
+#'
+#' @description
+#' The `launch_ui()` function installs and launches the DuckDB UI extension
+#' for an active DuckDB database connection. This allows users to interact
+#' with the database via a web-based graphical interface.
+#'
+#' Your connection from [create_contoso_duckdb()] is returned in the list.
+#'
+#' @param .con A valid `DBIConnection` object connected to a DuckDB database.
+#' The function will check that the connection is valid before proceeding.
+#'
+#' @details
+#' The function performs the following steps:
+#'
+#' * Checks that the provided DuckDB connection is valid.
+#'    If the connection is invalid, it aborts with a descriptive error message.
+#' * Installs the `ui` extension into the connected DuckDB instance.
+#' * Calls the `start_ui()` procedure to launch the DuckDB UI in your browser.
+#'
+#' This provides a convenient way to explore and manage DuckDB databases
+#' interactively without needing to leave the R environment.
+#'
+#' @return
+#' The function is called for its side effects and does not return a value.
+#' It launches the DuckDB UI and opens it in your default web browser.
+#' @seealso
+#' - [create_contoso_duckdb()] for creating example Contoso datasets in DuckDB.
+#' - [DBI::dbConnect()] and [DBI::dbDisconnect()] for managing DuckDB connections.
+#' - [duckdb::duckdb()] for creating a DuckDB driver instance.
+#' @examples
+#' \dontrun{
+#' # Connect to DuckDB
+#' db <- create_contoso_duckdb()
+#'
+#' # Launch the DuckDB UI
+#' launch_ui(db$con)
+#'
+#' # Clean up
+#' DBI::dbDisconnect(db$con, shutdown = TRUE)
+#' }
+#'
+#' @export
+launch_ui <- function(.con){
+
+  if (!DBI::dbIsValid(db$con)) {
+
+    cli::cli_abort("Database connection is invalid, please reconnect before proceeding.")
+  }
+
+  DBI::dbExecute(.con,"install ui;")
+
+  DBI::dbExecute(.con,"CALL start_ui()")
+
+}
+
+
+
+utils::globalVariables(c("db"))

README.html

@@ -83,12 +83,7 @@
 
 
 
-<div class="quarto-figure quarto-figure-center">
-<figure class="figure">
-<p><img src="man/figures/logo.png" class="img-fluid figure-img"></p>
-<figcaption>logo</figcaption>
-</figure>
-</div>
+<p><img src="man/figures/logo.png" class="img-fluid"></p>
 <p>Contoso is a synthetic dataset containing sample sales transaction data for the fictional “Contoso” company. It includes various supporting tables for business intelligence, such as customer, store, product, and currency exchange data.</p>
 <p>This dataset is perfect for practicing time series analysis, joins, financial modeling, or any business intelligence-related tasks.</p>
 <p>It comes with a built-in dataset as well as the ability to create an in-memory database with <a href="https://duckdb.org/">duckdb</a></p>
@@ -164,19 +159,19 @@ <h3 class="anchored" data-anchor-id="dataset-overview">Dataset overview</h3>
 
     <script>
       // Create table-specific functions using external factory
-      const tableFns_1w4a7siixuaimqxdf5pk = TinyTable.createTableFunctions("tinytable_1w4a7siixuaimqxdf5pk");
+      const tableFns_s48fp1hkow64cexbrs1q = TinyTable.createTableFunctions("tinytable_s48fp1hkow64cexbrs1q");
       // tinytable span after
       window.addEventListener('load', function () {
           var cellsToStyle = [
             // tinytable style arrays after
-          { positions: [ { i: '5', j: 1 }, { i: '5', j: 2 }, { i: '5', j: 3 }, { i: '5', j: 4 }, { i: '5', j: 5 }, { i: '5', j: 6 }, { i: '5', j: 7 } ], css_id: 'tinytable_css_e8grj3k1xqq4i47rabie',}, 
-          { positions: [ { i: '0', j: 1 }, { i: '0', j: 2 }, { i: '0', j: 3 }, { i: '0', j: 4 }, { i: '0', j: 5 }, { i: '0', j: 6 }, { i: '0', j: 7 } ], css_id: 'tinytable_css_it5dtezjsr54gafiy0q1',}, 
+          { positions: [ { i: '5', j: 1 }, { i: '5', j: 2 }, { i: '5', j: 3 }, { i: '5', j: 4 }, { i: '5', j: 5 }, { i: '5', j: 6 }, { i: '5', j: 7 } ], css_id: 'tinytable_css_xxcjrk94u3k2g5licaln',}, 
+          { positions: [ { i: '0', j: 1 }, { i: '0', j: 2 }, { i: '0', j: 3 }, { i: '0', j: 4 }, { i: '0', j: 5 }, { i: '0', j: 6 }, { i: '0', j: 7 } ], css_id: 'tinytable_css_1cmshl3bg9nwi6pk66ze',}, 
           ];
 
           // Loop over the arrays to style the cells
           cellsToStyle.forEach(function (group) {
               group.positions.forEach(function (cell) {
-                  tableFns_1w4a7siixuaimqxdf5pk.styleCell(cell.i, cell.j, group.css_id);
+                  tableFns_s48fp1hkow64cexbrs1q.styleCell(cell.i, cell.j, group.css_id);
               });
           });
       });
@@ -185,11 +180,11 @@ <h3 class="anchored" data-anchor-id="dataset-overview">Dataset overview</h3>
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/vincentarelbundock/tinytable@main/inst/tinytable.css">
     <style>
     /* tinytable css entries after */
-    #tinytable_1w4a7siixuaimqxdf5pk td.tinytable_css_e8grj3k1xqq4i47rabie, #tinytable_1w4a7siixuaimqxdf5pk th.tinytable_css_e8grj3k1xqq4i47rabie {  position: relative; --border-bottom: 1; --border-left: 0; --border-right: 0; --border-top: 0; --line-color-bottom: black; --line-color-left: black; --line-color-right: black; --line-color-top: black; --line-width-bottom: 0.1em; --line-width-left: 0.1em; --line-width-right: 0.1em; --line-width-top: 0.1em; --trim-bottom-left: 0%; --trim-bottom-right: 0%; --trim-left-bottom: 0%; --trim-left-top: 0%; --trim-right-bottom: 0%; --trim-right-top: 0%; --trim-top-left: 0%; --trim-top-right: 0%;  }
-    #tinytable_1w4a7siixuaimqxdf5pk td.tinytable_css_it5dtezjsr54gafiy0q1, #tinytable_1w4a7siixuaimqxdf5pk th.tinytable_css_it5dtezjsr54gafiy0q1 {  position: relative; --border-bottom: 1; --border-left: 0; --border-right: 0; --border-top: 1; --line-color-bottom: black; --line-color-left: black; --line-color-right: black; --line-color-top: black; --line-width-bottom: 0.05em; --line-width-left: 0.1em; --line-width-right: 0.1em; --line-width-top: 0.1em; --trim-bottom-left: 0%; --trim-bottom-right: 0%; --trim-left-bottom: 0%; --trim-left-top: 0%; --trim-right-bottom: 0%; --trim-right-top: 0%; --trim-top-left: 0%; --trim-top-right: 0%;  }
+    #tinytable_s48fp1hkow64cexbrs1q td.tinytable_css_xxcjrk94u3k2g5licaln, #tinytable_s48fp1hkow64cexbrs1q th.tinytable_css_xxcjrk94u3k2g5licaln {  position: relative; --border-bottom: 1; --border-left: 0; --border-right: 0; --border-top: 0; --line-color-bottom: black; --line-color-left: black; --line-color-right: black; --line-color-top: black; --line-width-bottom: 0.1em; --line-width-left: 0.1em; --line-width-right: 0.1em; --line-width-top: 0.1em; --trim-bottom-left: 0%; --trim-bottom-right: 0%; --trim-left-bottom: 0%; --trim-left-top: 0%; --trim-right-bottom: 0%; --trim-right-top: 0%; --trim-top-left: 0%; --trim-top-right: 0%;  }
+    #tinytable_s48fp1hkow64cexbrs1q td.tinytable_css_1cmshl3bg9nwi6pk66ze, #tinytable_s48fp1hkow64cexbrs1q th.tinytable_css_1cmshl3bg9nwi6pk66ze {  position: relative; --border-bottom: 1; --border-left: 0; --border-right: 0; --border-top: 1; --line-color-bottom: black; --line-color-left: black; --line-color-right: black; --line-color-top: black; --line-width-bottom: 0.05em; --line-width-left: 0.1em; --line-width-right: 0.1em; --line-width-top: 0.1em; --trim-bottom-left: 0%; --trim-bottom-right: 0%; --trim-left-bottom: 0%; --trim-left-top: 0%; --trim-right-bottom: 0%; --trim-right-top: 0%; --trim-top-left: 0%; --trim-top-right: 0%;  }
     </style>
     <div class="container">
-      <table class="tinytable" id="tinytable_1w4a7siixuaimqxdf5pk" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
+      <table class="tinytable" id="tinytable_s48fp1hkow64cexbrs1q" style="width: auto; margin-left: auto; margin-right: auto;" data-quarto-disable-processing="true">
 
         <thead>
               <tr>

README.md

@@ -1,6 +1,6 @@
 
 
-## Contoso
+![](man/figures/logo.png)
 
 Contoso is a synthetic dataset containing sample sales transaction data
 for the fictional “Contoso” company. It includes various supporting
@@ -45,8 +45,6 @@ Built into the package is the 10K row version of the dataset.
 Using `view()`, you can see the columns’ label using the
 [labelled](https://larmarange.github.io/labelled/index.html) package.
 
-> [!NOTE]
->
 > Inspiration to using
 > [labelled](https://larmarange.github.io/labelled/index.html) comes
 > from [Crystal Lewis](https://cghlewis.com/blog/dict_clean/) excellent

README.qmd

@@ -37,9 +37,8 @@ Built into the package is the 10K row version of the dataset.
 
 Using `view()`, you can see the columns' label using the [labelled](https://larmarange.github.io/labelled/index.html) package.
 
-::: {.callout-note}
-Inspiration to using [labelled](https://larmarange.github.io/labelled/index.html) comes from [Crystal Lewis](https://cghlewis.com/blog/dict_clean/) excellent blog post
-:::
+
+> Inspiration to using [labelled](https://larmarange.github.io/labelled/index.html) comes from [Crystal Lewis](https://cghlewis.com/blog/dict_clean/) excellent blog post
 
 If you want a larger dataset, there is also 100K, 1M, 10M and 100M row version which can be created with `create_contoso_duckdb()` function.