From 6232948e2a7009cfcd8ef813f4a3b84e7ef7e3ed Mon Sep 17 00:00:00 2001
From: Ben Anderson <dataknut@icloud.com>
Date: Wed, 8 Jul 2020 10:07:21 +0100
Subject: [PATCH] a bunch of tidying up. Sorry if it breaks things
---
README.md | 6 +++---
howTo/drake.md | 9 +++++++++
gitBranches.md => howTo/gitBranches.md | 0
resources.md => howTo/otherResources.md | 10 ++--------
.../shortCourseSyllabusOutline.md | 0
woRkflowWorkshop.md => howTo/woRkflowWorkshop.md | 0
6 files changed, 14 insertions(+), 11 deletions(-)
create mode 100644 howTo/drake.md
rename gitBranches.md => howTo/gitBranches.md (100%)
rename resources.md => howTo/otherResources.md (66%)
rename shortCourseSyllabusOutline.md => howTo/shortCourseSyllabusOutline.md (100%)
rename woRkflowWorkshop.md => howTo/woRkflowWorkshop.md (100%)
diff --git a/README.md b/README.md
index 3a918c1..66a2b61 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,9 @@ How we do collaborative reproducible data analysis and reporting. Mostly (but no
This repo does three things:
- * it is a collection of R [how-to resources](resources.md) including some notes on:
- * how to [use git branches](gitBranches.md)
- * how to use [drake](https://docs.ropensci.org/drake/) to massively speed up and [manage your workflow](https://milesmcbain.xyz/the-drake-post/)
+ * it is a collection of R [how-to resources](howTo/resources.md) including some notes on:
+ * how to [use git branches](howTo/gitBranches.md)
+ * how to use [drake](howTo/drake.md) to massively speed up and [manage your workflow](https://milesmcbain.xyz/the-drake-post/)
* it is a [template](repoAsATemplate.md) repo that illustrates how we work and which you can copy;
* it is an R package that you can build if you want to using 'install and restart' from the RStudio Build menu. If you do you will then be able to use its functions viz: `woRkflow::functionName()` (not that it has many).
diff --git a/howTo/drake.md b/howTo/drake.md
new file mode 100644
index 0000000..52099bc
--- /dev/null
+++ b/howTo/drake.md
@@ -0,0 +1,9 @@
+# drake:
+
+ * use [drake](https://docs.ropensci.org/drake/) to massively speed up and [manage your workflow](https://milesmcbain.xyz/the-drake-post/). This includes always:
+ * loading and processing all your data inside a drake plan in a .R file. _So it only gets re-run if the code or data changes_
+ * creating each of your output objects inside the drake plan. _So they only get re-created if the code or data changes_
+ * rendering your .Rmd report at the end of the drake plan. _So you can pass the params in and report the output objects_
+ * => the first time you run the plan it will build everything. The second time, e.g. after you fix a .Rmd typo, _only the bits that have changed get re-built_. **Warning: drake can reduce the time it takes to run your code by an order of magnitude. This could seriously damage your tea & cake in-take...**
+
+We have an example of [using drake](https://git.soton.ac.uk/SERG/workflow/-/blob/master/Rmd/make_basicReport.R)
\ No newline at end of file
diff --git a/gitBranches.md b/howTo/gitBranches.md
similarity index 100%
rename from gitBranches.md
rename to howTo/gitBranches.md
diff --git a/resources.md b/howTo/otherResources.md
similarity index 66%
rename from resources.md
rename to howTo/otherResources.md
index 6ae99d5..ec8925e 100644
--- a/resources.md
+++ b/howTo/otherResources.md
@@ -1,4 +1,4 @@
-## 'How to' resources:
+# Other 'How to' resources:
* excellent [guidance for collaborative project teams (especially team leads)](https://opensource.guide/) even if they're not open and not R
* [What they forgot to teach you](https://rstats.wtf/) about R including some required reading:
@@ -14,10 +14,4 @@
* we have written a [short guide](gitBranches.md)
* [HappyGit](https://happygitwithr.com/fork-and-clone.html) gives you the details
* [ohshitgit](https://ohshitgit.com/) may be required here too (but not if you've followed the instructions above)
- * using [git(hub/lab) issues](https://guides.github.com/features/issues/) as a way to manage your project - just like we did for the [new ECCD website](https://git.soton.ac.uk/SERG/sergwebsite/-/issues)
- * how to use [drake](https://docs.ropensci.org/drake/) to massively speed up and [manage your workflow](https://milesmcbain.xyz/the-drake-post/). This includes always:
- * loading and processing all your data inside a drake plan in a .R file. _So it only gets re-run if the code or data changes_
- * creating each of your output objects inside the drake plan. _So they only get re-created if the code or data changes_
- * rendering your .Rmd report at the end of the drake plan. _So you can pass the params in and report the output objects_
- * => the first time you run the plan it will build everything. The second time, e.g. after you fix a .Rmd typo, _only the bits that have changed get re-built_. **Warning: drake can reduce the time it takes to run your code by an order of magnitude. This could seriously damage your tea & cake in-take...**
-
\ No newline at end of file
+ * using [git(hub/lab) issues](https://guides.github.com/features/issues/) as a way to manage your project - just like we did for the [new ECCD website](https://git.soton.ac.uk/SERG/sergwebsite/-/issues)
\ No newline at end of file
diff --git a/shortCourseSyllabusOutline.md b/howTo/shortCourseSyllabusOutline.md
similarity index 100%
rename from shortCourseSyllabusOutline.md
rename to howTo/shortCourseSyllabusOutline.md
diff --git a/woRkflowWorkshop.md b/howTo/woRkflowWorkshop.md
similarity index 100%
rename from woRkflowWorkshop.md
rename to howTo/woRkflowWorkshop.md
--
GitLab