statnmap/sql-pet

Exploring a realistic postgreSQL database with R via Docker

SQL Pet Tutorial

Table of Contents

1. Project organization
2. Book
3. Prerequisites
4. Packages used in the book
5. How to contribute
6. Code of Conduct
7. License

Project organization

• Meeting agenda items go here: https://github.com/smithjd/sql-pet/projects/1
• Kanban is here: https://github.com/smithjd/sql-pet/projects/2
• Slack: self-invite is here

Book

• Tutorial materials from this repo go in the online book, "R, Databases and Docker".

• Each chapter is written so it can be executed independently (once the Docker container is built in Chapter 5). We are using a Knit-then-Merge approach, so each chapter of the book can be Knitted separately.

• The book depends on the sqlpetr package, which can be installed using:

  remotes::install_github("smithjd/sqlpetr", force = TRUE, quiet = TRUE, build = TRUE, build_opts = "")

Prerequisites

You will need:

• A computer running
  • Windows (Windows 7 64-bit or late - Windows 10-Pro is recommended)
  • macOS
  • Linux (any Linux distro that will run Docker Community Edition, R, and RStudio will work)
• Current versions of R and RStudio
• Docker

Packages used in the book

Here are the R packages that are used in this project and are discussed in the book:

• DBI
• DiagrammeR
• RPostgres
• dbplyr
• devtools
• downloader
• glue
• here
• knitr
• skimr
• tidyverse
• sqlpetr (installs with: remotes::install_github("smithjd/sqlpetr", force = TRUE, quiet = TRUE, build = TRUE, build_opts = ""))
• bookdown

How to contribute

If you'd like to contribute to this project, start by searching through the issues and pull requests to see whether someone else has already raised a similar idea or question.

If you don't see your idea listed, and you think it fits into the goals of this project, do one of the following:

• If your contribution is minor, such as a typo fix, open a pull request.
• If your contribution is major, such as a new learning module or a significant restructuring of current code and training material, start by opening an issue first. That way, before you do any work, other people can weigh in on the discussion to make sure that your goals are aligned with the direction of the project.

We provide more guidelines for coding style and developer's workflow in the Contributing document. The project wiki is also a good source of information for developers.

To compile the book, you need to additionally install webshot, so that HTMLwidgets are displayed properly:

   install.packages("webshot")
   webshot::install_phantomjs()

Then run the build_book.R script to compile the book.

Code of Conduct

If you plan to participate in the project in any way, such as a developer, reviewer, contributor, committer, or student, you are expected to follow the project's Code of Conduct. Please review those guidelines before choosing to participate in the project.

License

Software in this project is licensed under the MIT License.