From eb3f4e922ab066d55757564d4708ecdd134326b3 Mon Sep 17 00:00:00 2001 From: Thomas Rushby <t.w.rushby@soton.ac.uk> Date: Tue, 23 Jun 2020 09:21:06 +0100 Subject: [PATCH] Outline syllabus --- syllabus.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 syllabus.md diff --git a/syllabus.md b/syllabus.md new file mode 100644 index 0000000..6dec8c0 --- /dev/null +++ b/syllabus.md @@ -0,0 +1,44 @@ +# A workshop or short course syllabus + +## why + +Why not? + +To provide a (number) of session(s) on our woRkflow and the tools we use to organise/collaborate/generally make us work more effectively. + +## what + +An outline of topics covered by such a course might be as follows: + +* Why bother? + * Organisation and collaboration + * Reproducibility + * Documentation as-you-go (link to R packages) + +* Collaboration tools - overview + * Communication: MS Teams/Slack <-> and (Git) integration + * + +* Github/Gitlab + * Repositories (set up) - integration with R + * Collaboration - forking (hell) - branching - developing - merging + +——R Specific (optional?) — — + +* Repository structure - recommendations/best practice + +* R tools + * RStudio: + * Git/RStudio integration: git made simple (for command line/Terminal phobics) + * Packages: containers for functions (+ other useful stuff) & documentation as-you-go + * Drake: for workflow management and reproducibility + +* R tools UoS specific + * Soton RStudio server + +## who + +Everyone! + +## how + -- GitLab