Home

Welcome to the JoesFlow wiki!

Here are a few commands that are useful when developing this package:

Spell checking

When running devtools::check(), a quick spellcheck is run on the package. If any possible misspelled words are found: review, fix and run spelling::update_wordlist() to avoid the warning on any correctly spelled words that aren't in the default dictionary.

Docker

• To build the image: docker build -t idssniaid/joes-flow:0.1.1 . inside of the repository root directory.

  • Use the --no-cache flag to do a fresh install from the top of the Dockerfile.
  • Version tag follows ':'.

• To push the image to DockerHub: docker push idssniaid/joes-flow:0.1.1.

  • When pushing to production, replace the latest tag with the current version.

• To run the image: docker run --user shiny -p 3838:3838 idssniaid/joes-flow

• To run the image in interactive mode: docker run -ti -p 3838:3838 idssniaid/joes-flow bash

• Production images are located at idssniaid/joes-flow

• Development images are located at idssniaid/joes-flow-dev

The Shiny app is located at /srv/shiny-server/JoesFlow, and log files are at /var/log/shiny-server. (log files seem to disappear fairly quickly after being generated, so copying them into another directory might be helpful)

Testing

• Run devtools::test() and devtools::check() on the local copy.
• Build the Docker image
• Run all tests again on the Docker image

R package version management

We are using https://packagemanager.rstudio.com for managing R package versions to keep things consistent for previous versions.