STAT 545A Collaborative Project Milestone 1

Description

This project aims to investigate the git + GitHub workflow and troubleshoot code. It is a collaborative effort by Yifan, Wakeel, Javier and James.

Table of Contents

• Description
• Files in the Repository
• How to Run Code

Files in the Repository

• README.md: the introduction document for the project(essentially if you come back after 2 years, read this re-jog your memory)
• TEAMWORK.md: Describes guidelines for team collaboration.
• troubleshooting-1.Rmd: R Markdown document for troubleshooting exercises.
• • troubleshooting-2.Rmd: R Markdown document for higher level /more difficult troubleshooting exercises.
• [Other Files]: Descriptions...

How to Run Code from This Repository

Pre-requisites

1. Ensure you have R and RStudio installed on your computer. Download R from CRAN and RStudio from rstudio.com.

Steps

Clone the Repository using RStudio

1. Launch RStudio.
2. Go to File -> New Project.
3. Choose Version Control.
4. Select Git.
5. In the "Repository URL" field, paste the URL of the GitHub repository.
6. Choose where to save the repository in the "Create project as subdirectory of" field.
7. Click Create Project.

Install Required Packages

1. Open the R console within RStudio.
2. If there's a file like requirements.R or install_packages.R in the repository, run it. Otherwise, manually install packages.

Run the Code

1. If the code is in an R script, you can run it by clicking Source.
2. If the code is in an R Markdown file, you can knit the document by clicking the Knit button.

Troubleshooting

• If you encounter errors or missing packages, the error messages usually provide clues about what's missing or what needs to be fixed.