External usage

How to adopt this course

Not all data used within the practicals is distributed on GitHub due to size limitations. Each practical describe how to access the datasets used within.

There are two main options to adopt this course:

  1. Adopt the course in its entirety:
  • Install R and RStudio
  • Clone the project from GitHub to RStudio (in RStudio, File > New Project > Version Control > Git)
  • Install the renv package and install all packages within the project using renv::restore(). On the project’s GitHub the renv.lock file contains all of the packages (and versions) used within it.
  • If you wish to build the book at any point, practicals (RMarkdown files) without data can be removed by commenting out the file (with a #) in the _bookdown.yml file.

For more details on how to use Git, GitHub and renv see the practical Git, GitHub and RMarkdown

  1. Adopt a single practical by downloading the .rmd file, packages loaded within the .rmd file and associated data from the links listed within it.

How to contribute

We welcome contributions to the material either directly, for any small issues or errors (e.g. typos) or through a GitHub issue for larger issues (e.g. further explanation requests, bugs in the code)

For smaller issues click the button in the top tool bar:

  • Create a fork of the repository and clone it to your local computer
  • Create a local branch
  • Make changes to that branch (commit them)
  • Push the changes to your GitHub fork
  • Once you have made then open a pull request for it to be considered.

For larger issues open a issue on the project’s GitHub issue page.

If raising an issue please provide sufficient detail that it can be reproduced with a minimal worked example (where possible). Be sure to include the following:

  • A short explanation of the bug and it’s environment (e.g. operating system).
  • A step by step guide to reproduce it.

For clarification on concepts please either open an issue on the project’s GitHub issue page or submit the anonymous feedback form at the end of each practical.

Alternatively, reach out to us on Twitter:

Supporting the module

If you found the content useful, please support us by:

License

If you use this material for teaching, research or anything else please let me (Andy) know via Twitter or email — a [dot] maclachlan [at] ucl [dot] ac [dot] uk).

This practical book is licensed under a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) License.

You are free to:

  • Share — copy and redistribute the material in any medium or format

  • Adapt — remix, transform, and build upon the material for any purpose, even commercially.

However, you give appropriate credit, provide a link to the license, and indicate if changes were made. If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

But, you do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.

Updates

This is the third iteration of the practical book, representing the third year it has been hosted in this format.

Previous versions can be found at the following links.

A summary of changes is provided on the current README.md file: https://github.com/andrewmaclachlan/CASA0005repo

Packages

This bookdown document was built with:

## Finding R package dependencies ... Done!
##  setting  value
##  version  R version 4.4.1 (2024-06-14 ucrt)
##  os       Windows 11 x64 (build 22631)
##  system   x86_64, mingw32
##  ui       RTerm
##  language (EN)
##  collate  English_United Kingdom.utf8
##  ctype    English_United Kingdom.utf8
##  tz       Europe/London
##  date     2024-10-29
##  pandoc   3.2 @ C:/Program Files/RStudio/resources/app/bin/quarto/bin/tools/ (via rmarkdown)

And makes use of the following packages throughout. Thanks to STAT 545 for this code.