From b66f3e85872ae951d77ee95920d87ab7fcc57434 Mon Sep 17 00:00:00 2001
From: "B.Anderson" <ba1e12@srv02405.soton.ac.uk>
Date: Sun, 17 May 2020 18:57:18 +0100
Subject: [PATCH] added basic folder structure

---
 .gitignore         |  5 +++++
 R/README.md        |  7 +++++++
 analysis/README.md | 10 ++++++++++
 docs/README.md     |  7 +++++++
 notData/README.md  |  7 +++++++
 5 files changed, 36 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 R/README.md
 create mode 100644 analysis/README.md
 create mode 100644 docs/README.md
 create mode 100644 notData/README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..52c1c38
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,5 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+*.Rproj
\ No newline at end of file
diff --git a/R/README.md b/R/README.md
new file mode 100644
index 0000000..8dda637
--- /dev/null
+++ b/R/README.md
@@ -0,0 +1,7 @@
+# woRkflow
+
+## R
+
+The place to keep functions - see [template info](../template.md).
+
+We recommend using [roxygen](https://roxygen2.r-lib.org/) style [documentation](https://style.tidyverse.org/documentation.html).
\ No newline at end of file
diff --git a/analysis/README.md b/analysis/README.md
new file mode 100644
index 0000000..6000e34
--- /dev/null
+++ b/analysis/README.md
@@ -0,0 +1,10 @@
+# woRkflow
+
+## analysis
+
+The place to put your analysis code - see [template info](../template.md).
+
+In most cases we use:
+
+ * make_xxxx.R <- where we do all the heavy lifting and output object creation via drake and then render...
+ * xxx.Rmd <- where we report the output objects. The results go in [docs/](../docs/)
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..346a490
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,7 @@
+# woRkflow
+
+## docs
+
+The place to put the **output** of your analysis code - see [template info](../template.md).
+
+Frequently used as the document store for github pages...
\ No newline at end of file
diff --git a/notData/README.md b/notData/README.md
new file mode 100644
index 0000000..289c3d0
--- /dev/null
+++ b/notData/README.md
@@ -0,0 +1,7 @@
+# woRkflow
+
+## notData
+
+The place **not** to put any data - see [template info](../template.md).
+
+We recommend keeping your data somewhere else e.g. an institutional data store.
\ No newline at end of file
-- 
GitLab