Merge pull request #35 from 3mmaRand/core-week-11-fixes

fixes

core/week-11/overview.qmd

@@ -5,7 +5,7 @@ toc: true
 toc-location: right
 ---
 
-xxxxx
+This week we will cover the "Research compendium" which is part of the assessment. A research compendium can be a single RStudio Project but we have broadened the definition. It is a documented collection of all the digital parts of the research project including data (or access to data), code and outputs. The collection is organised and documented in such a way that reproducing all the results is straightforward for another individual.
 
 ### Learning objectives
 
@@ -32,4 +32,5 @@ The successful student will be able to:
 2.  [Workshop](workshop.qmd)
 
 
+3.  Consolidate by working on your project and research compendium
 

core/week-11/study_after_workshop.qmd

@@ -9,19 +9,4 @@ format:
     code-summary: "Answer - don't look until you have tried!"
 ---
 
-# Set up
-
-If you have just opened RStudio you will want to load the packages and import the data.
-
-```{r}
-#| code-fold: false
-library(tidyverse)
-library(readxl)
-```
-
-1.  💻 xx.
-
-```{r}
-
- 
-```
+💻 Just work on your project!

core/week-11/study_before_workshop.qmd

@@ -19,23 +19,20 @@ editor:
 
 This module is assessed by:
 
-
 -   Oral presentation 30%
 
 -   Project Report and Research Compendium 70% of which
 
-    -   70% report (*i.e.*, 49% of the total mark)
-    -   30% compendium (*i.e.*, 21% of the total mark)
+    -   50% report
+    -   20% compendium
 
 These slides are a guide to Research compendium.
 
-
 ## What is a Research Compendium?
 
 **Overview of assessment**
 
-::: {style="font-size: 60%;"}
-
+::: {style="font-size: 65%;"}
 *Stage 3 Integrated Masters students are expected to submit a Research
 Compendium that is a documented collection of all the digital parts of
 the research project including data (or access to data), code and
@@ -50,56 +47,51 @@ clarity of the decision making processes rather than the interpretation
 of the results which is covered in the report. There is no word or size
 limit for any part of the compendium but its contents should be concise
 and minimal. Extraneous text, code or files will be penalised.*
-
 :::
 
 ## What is a Research Compendium?
 
 **Overview of assessment**
 
-::: {style="font-size: 60%;"}
-
+::: {style="font-size: 65%;"}
 *Stage 3 Integrated Masters students are expected to submit a Research
-Compendium that is a **documented collection of all the digital parts of
-the research project** including data (or access to data), code and
-outputs. The collection is **organised and documented in such a way that
-reproducing all the results is straightforward** for another
+Compendium that is a* **documented collection of all the digital parts
+of the research project** *including data (or access to data), code and
+outputs. The collection is* **organised and documented in such a way
+that reproducing all the results is straightforward** *for another
 individual.*
 
-*Students will be assessed on the **technical complexity, completeness
-and organisation of their compendium** and the **completeness,
+*Students will be assessed on the* **technical complexity, completeness
+and organisation of their compendium** *and the* **completeness,
 reproducibility and clarity of their documentation at the project and
-code/process level.** Marking will focus on the reproducibility of the
+code/process level.** *Marking will focus on the reproducibility of the
 results and the clarity of the decision making processes rather than the
 interpretation of the results which is covered in the report. There is
 no word or size limit for any part of the compendium but its contents
 should be concise and minimal. Extraneous text, code or files will be
 penalised.*
-
 :::
 
 ## What is a Research Compendium?
 
 ::: {style="font-size: 80%;"}
-
 ::: incremental
 -   Zipped folder containing all data, code and text associated with a
     research project organised and documented clearly. Any unscripted
     processing should be described.
 
--   Everything needed to understand what the project is and reproduce 
-    the results, and no more. The compendium should not be a dumping 
-    ground for data files and scripts. It needs to be curated. You 
-    may generate files that are not needed to reproduce your work and 
-    these should be removed.
+-   Everything needed to understand what the project is and reproduce
+    the results, and no more. The compendium should not be a dumping
+    ground for data files and scripts. It needs to be curated. You may
+    generate files that are not needed to reproduce your work and these
+    should be removed.
 
 -   Your compendium might be a single Quarto/RStudio Project, or it
     might be folder including an RStudio Project and some additional
     materials including the description of unscripted processing.
 
 -   Ideally uses literate programming to create submitted report
 :::
-
 :::
 
 ## Use guidelines from Core 1 and 2
@@ -110,7 +102,8 @@ penalised.*
 
 -   follow the guidance in [Core
     2](https://3mmarand.github.io/BIO00088H-data/core/week-2/overview.html)
-    on well-formatted code, consistency, modularisation and documentation
+    on well-formatted code, consistency, modularisation and
+    documentation
 
 ## Project level documentation
 
@@ -119,8 +112,8 @@ penalised.*
 
 -   primarily in the README file but some details may be in scripts
 
--   title, concise description of the work, author exam number, date, overview 
-    of compendium contents
+-   title, concise description of the work, author exam number, date,
+    overview of compendium contents
 
 -   all the software information including versions