README.md

group8

R-CMD-check

codecov

Predicting Student Performance using Study Time - Package

Group 8

Group Members

Contributors:

Isabela Lucas Bruxellas (33569286) Tony Liang (39356993) Xue Wang (50938547) Anam Hira (67844266)

Project Summary

In this project, we will explore and predict students’ exam performance about Electrical DC Machines based on their study time by using linear regression (LN) and the K-nearest neighbors (K-NN) algorithm. This result could help students gain insight into the necessary study time for specific scores as well as help instructors better understand the performance of students.

The repository with the analysis can be found here

This package contains the functions necessary for the analysis.

Report

The analysis report can be found here.

Installation

You can install the development version of group8 from GitHub with:

# install.packages("devtools")
devtools::install_github("DSCI-310/DSCI-310-Group-8-package")

Usage

The DSCI-310-Group-8-package has four functions here,

By running the code block above on your R file.

The usage for function references can be found here .

Attention:

# install.packages("devtools")

Needs to used if devtools is not already installed in your local repository. Otherwise, it can be skipped

Dependencies

R version 4.1.1, Jupyter and R packages listed in environment.yml.

Licenses

DSCI-310-Group-8-package was created by Isabela Lucas Bruxellas, Tony Liang, Xue Wang, Anam Hira.

This package is licensed under the MIT License and Creative Commons Attribution-NonCommerical-NoDerivatives 4.0 International License Creative Commons License

Attention: In order to properly run this project, ensure that you are using the same versions when running the project in the Dockerfile.



DSCI-310/DSCI-310-Group-8-package documentation built on April 21, 2022, 3:55 a.m.