Add vignettes

[richfitz]

Primariliy this PR adds a vignette (rrq.Rmd) and also an annex with information about messages (messages.Rmd). I took the opportuity to add some sort of README too (README.Rmd -> README.md) and spell check the package.

I did sneak in a helper function rrq_envir as that made the vignette easier to write, and tidied up a little bit of lint (dockerfile) and deleted a stray obsolete python file

[codecov[bot]]

Codecov Report

Merging #50 (fa855e5) into master (4b39a11) will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##            master       #50   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           24        25    +1     
  Lines         1666      1684   +18     
=========================================
+ Hits          1666      1684   +18     

Impacted Files	Coverage Δ
R/object_store.R	100.00% <ø> (ø)
R/rrq_controller.R	100.00% <ø> (ø)
R/worker.R	100.00% <ø> (ø)
R/worker_runner.R	100.00% <ø> (ø)
R/envir.R	100.00% <100.00%> (ø)
R/utils.R	100.00% <100.00%> (ø)
R/utils_assert.R	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3d3ff49...fa855e5. Read the comment docs.

[r-ash]

Question about building vignettes here, if I make a code change I have to rebuild manually with make vignettes then push to github?

There is nothing in the CI which builds from vignettes_src to vignettes - (as we discussed) deliberately because it means we don't need redis available for vignette build? I think this is what made vignettes in naomi regress quite badly. People made breaking code change and forget to manually run vignettes so they don't get caught. Maybe this is better than the alternative - but is it so bad to have redis running when vignettes are built? We have redis running for test suite already. At the moment also have to update Makefile if you add a vignette or change file name which would go if they can just be generated by R CMD check.

Discussed this offline - they do get built by CI on CI (linux & mac)

• All vignettes are copied from vignettes_src to vignettes (will overwrite the files currently in vignettes dir)
• R CMD check step will build them (using running redis)

On windows

• Uses pre-generated vignettes in vignettes dir

Though we should still locally run the vignettes as the version in the github repo in vignettes dir (i.e. the version manually created) is what users will install from drat or via remotes::install_github.