diff --git a/README.md b/README.md index 980715ec0e390388c3fd5797155c4ef0479fca11..4529326b43f8b240b6033ece2d402e2de6f465d3 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,9 @@ This repo is an R package. This means: * package functions are kept in /R * help files auto-created by roxygen are in /man * if you clone it you can build it and use the functions - * Rmd scripts for reporting the results of drake plans are in /Rmd + * drake::rmake(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 in _drake_XX.R and used for reporting the results of drake plans are in /Rmd * outputs are kept in /docs (reports, plots etc) * you (and we) keep your data out of it!