Merge pull request #68 from OxfordIHTM:dev

update README; fix #65; fix #66; fix #67

README.md

@@ -1,8 +1,41 @@
 
-# The University of Oxford International Health and Tropical Medicine R and Reproducible Research Handbook <img src="images/ihealth_base_pos.png" align="right" height="200px" />
+# Open and Reproducible Science in R Technical Handbook <img src="images/ihealth_base_pos.png" align="right" height="200px" />
 
 <!-- badges: start -->
+[![License for code](https://img.shields.io/badge/license (for code)-GPL3.0-blue.svg)](https://opensource.org/licenses/gpl-3.0.html)
+[![License for text](https://img.shields.io/badge/license (for text)-CC0-blue)](https://creativecommons.org/public-domain/cc0/)
 [![Quarto Publish](https://github.com/OxfordIHTM/ihtm-handbook/actions/workflows/publish.yml/badge.svg)](https://github.com/OxfordIHTM/ihtm-handbook/actions/workflows/publish.yml)
+[![DOI](https://zenodo.org/badge/476961453.svg)](https://doi.org/10.5281/zenodo.13643259)
 <!-- badges: end -->
 
 
+# Preface {.unnumbered}
+
+The Open and Reproducible Science in R sub-module of the [MSc in International Health and Tropical Medicine](https://www.tropicalmedicine.ox.ac.uk/study-with-us/msc-ihtm) is designed to equip students with the knowledge and skills necessary to conduct both **academic research** and more importantly **real-world data analysis** that is transparent, reproducible, and in line with the principles of open science.
+
+This tecnical handbook serves as the *go-to* guide for MSc IHTM students to the various tools, technologies, and processes that they will be learning and using within the module.
+
+## Organisation
+
+This handbook is divided into three sections:
+
+### 1. Tools
+
+This section cover topics on the various tools and technologies that are to be used and/or introduced in the module. The [R](https://r-project.org) *language and environment for statistical computing and graphics* is primary of these as the module is specific to R. All other tools and tecnologies are either built specific for use with R (e.g. [RStudio](https://posit.co/products/open-source/rstudio/) which is the IDE of choice for the module and for this handbook) or are general tools that enhance the *userR* experience and/or supports known and accepted best practices for open and reproducible science using R.
+
+### 2. Practices
+
+This section covers topics on recommended best practices for optimal usage and maintenance of R and RStudio.
+
+### 3. Processes
+
+This section covers topics on scientific/data analysis workflows with a focus on steps in initiating and setting up and participating and contributing to such projects within an open and reproducible framework.
+
+## How to use
+
+Even though all efforts have been made to order the chapters in a way that is coherent and logical, this handbook is designed such that chapters are standalone topics in of themselves and uses cross-referencing between chapters to make links to the various learning topics/concepts. As such, the best use of this handbook is to use each chapter as a reference for more in-depth discussion of a topic discussed in class rather than a book to read from start to finish.
+
+## License
+All code used to produce this handbook is released under a [GPL-3.0](https://opensource.org/licenses/gpl-3.0.html) license. 
+
+All text in this handbook is released under a [CC0](https://creativecommons.org/public-domain/cc0/) license.