PROJECT MEMBERS
Carley Winter, Heather Gordon, Bre Lambert and Ramin Rezaeianzadeh
UPDATE: 29 SEP 2023
Project Goals
This repository contains two collaborative projects ( Collaborative Project -Milestone 1 , Collaborative Project -Milestone 2 )in conjunction with UBC’s course, STAT 545A. This project has students collaborating through git + GitHub workflow, while also analyzing R code. The goal of this project is to grow students’ skills and confidence when working with R and Github.
Milestone 1 consists of three files and eight exercises, all which challenge students to efficiently communicate through Github and trouble shoot broken R code. Detailed instructions on each exercise can be found here.
In Milestone 2 of the STAT 545A Collaborative Project, we focus on collaborative Git and GitHub workflow, troubleshooting the second set of R code, and documentation. We must create and merge pull requests, fix errors in the troubleshooting document, and update the README file. This milestone emphasizes teamwork, technical skills, and effective project management. here.
Files in Repository
“collaborative-group8”, consists of four files:
| Files | Description |
|---|---|
| 1. README.md File | a. A README file should be present in all projects providing instructions on the tasks ensuring one has a full and detailed understanding of the requirements and goals of the project. b. The README should contain an explanation of all additional files in the repository. c. If there is code to be analysed, an instructional guide to analyze the data and transfer it to GitHub should be provided. |
| 2. TEAMWORK.md File | a. Our TEAMWORK file contains a group contract allowing for expectations to be communicated and agreed upon among members. This document includes how tasks will be divided among group members, clear deadlines for each task, and an agreed upon communication platform that will be used to discuss the project among all group members (e.g. Slack or GitHub Issues). |
| 3. Troubleshooting-1.md File | a. This file contains three broken chunks of R code which must be investigated and solved. Annotations should be added to clearly layout what was wrong and what was edited to resolve the errors of the original R code. |
| 4. Troubleshooting-2.md File | a. This file contains 11 broken chunks of R code which must be investigated and solved. Annotations should be added to clearly layout what was wrong and what was edited to resolve the errors of the original R code. |
Transferring R code to Github
- Copy the URL of the Github repository containing all files of interest.
- Create a new project in R, click “version control”, then click “Git”, paste the URL to the Github repository. Once completed, your files on that repository should be accessible in R studio, select the one you wish to work on.
- Once you have finished your R code, save the script.
- In the Environment section, you can select the checked box beside your recently saved file and then click “commit”.
- A pop up will appear, you should add a comment outlining the recent changes to the R code.
- Once completed, you “Push” your file to transfer the updates to Github.