From d939ae16dba043eb11e73bacedbc3b09ae8d4ea0 Mon Sep 17 00:00:00 2001
From: Ben Anderson <b.anderson@soton.ac.uk>
Date: Sun, 17 May 2020 18:39:37 +0100
Subject: [PATCH] Update template.md

---
 template.md | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

diff --git a/template.md b/template.md
index 1449c8b..f632286 100644
--- a/template.md
+++ b/template.md
@@ -2,7 +2,18 @@
 
 There are as many templates for (R) repos as there R users... Here's ours.
 
-We srtucture the repo as a package. We may never build it but usually we so so that the package functions are available everywhere in it
+We srtucture the repo as a package. We may never build it but usually we do so that the package functions are available everywhere in it
 
- * R/ - where we store functions
- * notData/ - 
\ No newline at end of file
+ * things you should touch:
+    * env.R        : where we store all the parameters that might be re-used across our repo. Such as colour defaults, data paths etc
+    * R/           : where we store functions that get built
+    * analysis/    : where we store .Rmd files and the .R scripts that call them (usually using a `drake` plan)
+    * docs/        : where we put output generated by the .R/.Rmd code. This is helpful if you are using [github/lab pages](https://guides.github.com/features/pages/). Unfortunately the University of Southampton gitlab service does not currently support this.
+    * notData/     : where we do not store data. R packages expect certain kinds of data in their 'data/' folders. Do not put your data in it. In fact we recommend **not** putting your data in your repo at all. Yes, this breaks true reproducability but there are reasons:
+        * we often use data that is commerecial or sensitive or personal (under GDPR) - so we cannot risk that leaking out
+        * we often use _very large_ datasets which most git/hub/lab services sensibly reject
+        * we often pull real time data on the fly from elsewhere so storage makes no sense
+
+ * things you should not touch:
+    * man/          : created by building the project/package
+    * NAMESPACE     : - ditto -
\ No newline at end of file
-- 
GitLab