Commit 1b4b5733 authored by Ben Anderson's avatar Ben Anderson
Browse files

Update README.md

parent 58da5813
......@@ -13,10 +13,11 @@ This repo is an R package. This means:
* help files auto-created by roxygen are in /man
* if you clone it you can build it and use the functions
* we use drake like this:
* drake::r_make(source = "_drake_XX.R") is run from inside a make_XX.R file
* the drake plan is kept inside _drake_XX.R along with the functions and package loading. This is not quite what the drake book recommends but it works for us
* Rmd scripts called by the drake plan that is specified in _drake_XX.R and used for reporting the results of drake plans are kept in /Rmd
* make_XX.R contains a call to drake::r_make(source = "_drake_XX.R")
* _drake_XX.R contans the drake plan and the functions & package loading. This is not quite what the [drake book](https://books.ropensci.org/drake/projects.html#usage) recommends but it works for us
* Rmd scripts called by the drake plan to report results are kept in /Rmd
* outputs are kept in /docs (reports, plots etc)
* if you can **run Rscript ./make_cleanFeeders.R in a terminal not at the RStudio console** <- this stops RStudio from locking up
* you (and we) keep your data out of it!
We'd love your contributions - feel free to:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment