diff --git a/README.md b/README.md index 9a2960b959bd49e7d9f489338b6e01415c6033e9..12c2526a552940b629610162e2604a4f6eadaf36 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 346a490df703e5a7a729fb0fd342ed0403312cfd..1882352aedbf76fb7505a722e4fc69d37a209629 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