From 949fb33ff5f4262abccd8ab165974eba6f5ea7df Mon Sep 17 00:00:00 2001
From: "B.Anderson" <ba1e12@srv02405.soton.ac.uk>
Date: Thu, 18 Jun 2020 21:09:37 +0100
Subject: [PATCH] renamed some stuff & added some extra notes
---
README.md | 9 +++++----
{analysis => Rmd}/README.md | 0
{analysis => Rmd}/basicReport.Rmd | 0
{analysis => Rmd}/make_basicReport.R | 0
docs/README.md | 5 ++++-
5 files changed, 9 insertions(+), 5 deletions(-)
rename {analysis => Rmd}/README.md (100%)
rename {analysis => Rmd}/basicReport.Rmd (100%)
rename {analysis => Rmd}/make_basicReport.R (100%)
diff --git a/README.md b/README.md
index 9a2960b..12c2526 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,10 @@
How we do collaborative reproducible data analysis and reporting. Mostly (but not only) using R. Inspired by [@AlexaLFH](https://twitter.com/AlexaLFH/status/1261633918782013440).
-This repo does two things:
+This repo does three things:
- * it is a collection of [resources](resources.md)
- * it is a [template](template.md) repo that illustrates how we work
+ * it is a collection of R [how-to resources](resources.md);
+ * it is a [template](template.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 (not that is has many useful functions).
-If you like how we work and want to use the repo as a template, simply [fork and go](https://happygitwithr.com/fork-and-clone.html).
\ No newline at end of file
+If you like how we work and want to use the repo as a template for your project or package, just [fork and go](https://happygitwithr.com/fork-and-clone.html).
\ No newline at end of file
diff --git a/analysis/README.md b/Rmd/README.md
similarity index 100%
rename from analysis/README.md
rename to Rmd/README.md
diff --git a/analysis/basicReport.Rmd b/Rmd/basicReport.Rmd
similarity index 100%
rename from analysis/basicReport.Rmd
rename to Rmd/basicReport.Rmd
diff --git a/analysis/make_basicReport.R b/Rmd/make_basicReport.R
similarity index 100%
rename from analysis/make_basicReport.R
rename to Rmd/make_basicReport.R
diff --git a/docs/README.md b/docs/README.md
index 346a490..1882352 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,4 +4,7 @@
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
+Why?
+
+ * it means you collect all your outputs and plots in one place so they're easy to find. If you name them sensibly...
+ * [github pages](https://pages.github.com/) use /docs as one of the default folders to publish from. If that means nothing to you, don't worry. git.soton.ac.uk doesn't support 'pages' (yet). We asked but the said no.
\ No newline at end of file
--
GitLab