Lecture "Project Management and Collaboration (using GitHub)"

The presentation and materials for a lecture "Project Management and Collaboration (using GitHub)" for SSoQE 2024.

Presentation

This lecture has a build-in presentation, which is accesible here

Structure and content

├─ Data
|   ├─ Input
|   ├─ Processed
|   └─ Temp
├─ docs
|   ├─ presentation_files
|   └─ index.html
├─ Presentation
|   ├─ .gitignore
|   ├─ color_palette.png
|   ├─ custom_theme.scss
|   ├─ presentation.qmd
|   └─ render.R
├─ R
|   ├─ ___Init_project___.R
|   ├─ 00_Config_file.R
|   ├─ Exercises
|   ├─ Functions
|   └─ Project
├─ renv
|   ├─ activate.R
|   ├─ library
|   └─ settings.json
├─ .gitignore
├─ .Rprofile
├─ Lecture_template.Rproj
├─ LICENSE
├─ README.md
└─ renv.lock

Setup

Getting the repo

The template is accessible in two ways:

1. If a user has a GitHub account, the easiest way is to create your own GitHub repo using this GitHub template. More details about how to use GitHub templates are on GitHub Docs.
2. Use can download the latest Release of the Workflow as a zip file.

Set up R project

Once a user obtains their version of the project, there are several steps to be done before using it:

• Update R and R-studio IDE. There are many guides on how to do so (e.g. here)
• Execute all individual steps with the R/___Init_project___.R script. This will result in the preparation of all R-packages using the {renv} package, which is an R dependency management of your projects. Mainly it will install {RUtilpol} and all dependencies. {RUtilpol} is used throughout the project as a version control of files.
• Set up your preferences by editing the The Config file in R/00_Config_file.R script. The Config file is a script where all settings (configurations) and criteria used throughout the project are predefined by the user before running individual scripts. In addition, it prepares the current session by loading the required packages and saving all settings throughout the project