yellowbrick

Connecting R and Yellowbrick with ADBC

Instructions

Tip

If you already have a Yellowbrick instance running, skip the steps to set up and clean up Yellowbrick.

Prerequisites

1. Install R

2. Install dbc

3. Install R packages adbcdrivermanager, arrow, and tibble:

   install.packages(c("adbcdrivermanager", "arrow", "tibble"))

Set up Yellowbrick

1. Install Docker

Warning

On Apple Silicon Macs, Yellowbrick Community Edition works with OrbStack but not with Docker Desktop.

2. Start a Yellowbrick Community Edition instance:

   docker run -d --rm --privileged --name yellowbrick -p 443:443 -p 5432:5432 yellowbrickdata/yb-community-edition:latest

3. Wait for the service to be ready (it should print localhost:5432 - accepting connections):

   docker exec yellowbrick pg_isready -h localhost -p 5432

Connect to Yellowbrick

1. Install the PostgreSQL ADBC driver:

   dbc install postgresql

2. Customize the R script main.R as needed

   • Change the connection arguments in adbc_database_init()
     • Format uri according to the connection URI format used by PostgreSQL, or keep it as is
   • Change the SQL SELECT statement in read_adbc() if desired

3. Run the R script:

   Rscript main.R

Clean up

Stop the Docker container running Yellowbrick:

docker stop yellowbrick