Skip to content
Functions to accompany the SQL Pet book
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R add docker_network parameter to sp_pg_docker_run Apr 25, 2019
docs
inst default port changed to 5439 Apr 7, 2019
man add docker_network parameter to sp_pg_docker_run Apr 25, 2019
tests clean up!! Feb 2, 2019
vignettes
.Rbuildignore
.gitattributes don't need to mess with line endings - the vignette bug is upstream Mar 28, 2019
.gitignore restore original .gitignore (issue #36) Feb 1, 2019
CODE_OF_CONDUCT.md RStudio and pkgdown infrastructure Oct 7, 2018
Contributing.md Localized 'Contributing.md' to this project. Oct 7, 2018
DESCRIPTION
LICENSE
NAMESPACE
README.Rmd
README.md pkgdown rebuild Mar 28, 2019
sqlpetr.Rproj

README.md

sqlpetr

Introduction

sqlpetr is the companion R package for the database tutorial eBook at https://github.com/smithjd/sql-pet. It has two classes of functions:

  1. Functions to install the dependencies needed to build the book and perform the operations covered in the tutorial, and
  2. Utilities for dealing with Docker and the PostgreSQL Docker image we use.

sqlpetr has a pkgdown site at https://smithjd.github.io/sqlpetr/.

Prerequisites

You will need the following software:

  1. R 3.4.0 or later:
  2. RStudio Preview 1.2.1330 or later (https://www.rstudio.com/products/rstudio/download/preview/).
  3. Docker:

See below for the details if you’re a Linux desktop user.

Installing this package for users of https://smithjd.github.io/sql-pet

If you are working through the code in the book, you will need to install this package first. Note that these instructions assume Windows or MacOS. For Linux, you will need to install some Linux packages. See below for the details on Ubuntu, Fedora or Arch Linux.

  1. Make sure you have a writeable personal library.

  2. Update all your packages with update.packages().

  3. Install remotes if you haven’t already.

  4. In an R console, type

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

Linux desktop

We support Ubuntu Linux 18.04 LTS (“Bionic Beaver”) or later, Fedora 28 or later and Arch Linux. You will need to install RStudio yourself, but we provide scripts to install all the other Linux dependencies including R and Docker.

  1. Install Linux - any desktop should work.

  2. Browse to https://github.com/smithjd/sqlpetr/tree/master/inst/linux. You will find install scripts for Ubuntu, Fedora and Arch. Download the one for your distro, make it executable and run it. The script will install R and the Linux dependencies for sqlpetr, install Docker, add you to the docker group and enable/start the Docker service.

  3. Now do

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

    to install sqlpetr.

Note that you will need to log out back to the display manager prompt and log back in for Docker commands to work without sudo.

You can’t perform that action at this time.