From 773a062e4441b20423564f353fbb2bb644b62c56 Mon Sep 17 00:00:00 2001 From: "B.Anderson" <ba1e12@srv02405.soton.ac.uk> Date: Sun, 17 May 2020 19:40:58 +0100 Subject: [PATCH] added links to objects discussed --- template.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/template.md b/template.md index be18a84..1918949 100644 --- a/template.md +++ b/template.md @@ -8,14 +8,18 @@ Things you should touch: | Item | Description | | --- | --- | -| **.gitignore** | A place to tell git what _not_ to synchronise e.g. `.csv` or [weird OS files](https://gist.github.com/adamgit/3786883)| -| **analysis/** | Where we store .Rmd files and the .R scripts that call them (usually using a `drake` plan) | -| **DESCRIPTION** | But only if you use this as a tmeplate for your own repo - it is a special file for packages | -| **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. | -| **env.R** | Where we store all the parameters that might be re-used across our repo. Such as colour defaults, data paths etc. We avoid using a project/repo level .Rprofile because it can lead to [a **lot** of confusion](https://support.rstudio.com/hc/en-us/articles/360047157094-Managing-R-with-Rprofile-Renviron-Rprofile-site-Renviron-site-rsession-conf-and-repos-conf). | -| **LICENSE** | Edit to suit your needs | -| **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. | -| **R/** | Where we store functions that get built | +| **[.gitignore](.gitignore)** | A place to tell git what _not_ to synchronise e.g. `.csv` or [weird OS files](https://gist.github.com/adamgit/3786883)| +| **[analysis/](analysis/)** | Where we store .Rmd files and the .R scripts that call them (usually using a `drake` plan) | +| **[DESCRIPTION](DESCRIPTION)** | But only if you use this as a tmeplate for your own repo - it is a special file for packages | +| **[docs/](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. | +| **[env.R](env.R)** | Where we store all the parameters that might be re-used across our repo. Such as colour defaults, data paths etc. We avoid using a project/repo level .Rprofile because it can lead to [a **lot** of confusion](https://support.rstudio.com/hc/en-us/articles/360047157094-Managing-R-with-Rprofile-Renviron-Rprofile-site-Renviron-site-rsession-conf-and-repos-conf). | +| **[LICENSE](LICENSE)** | Edit to suit your needs | +| **[notData/](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. | +| **[R/](R/)** | Where we store functions that get built | +| **[README.md](README.md)** | Repo readme | +| **[resources.md](resources.md)** | Our collection of guides and `how-tos` | +| **[template.md](template.md)** | This file | + > We recommend **not** putting your data in your repo at all. -- GitLab