diff --git a/README.md b/README.md index 3dae2fb50a776fd2f05e4a9b99ef84cf6992e648..995abe482c4884f1e57c988d91c1ee3123fe3498 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,24 @@ ## Overview This package provides the linear and ridge regression models using reference class. The package enables users to establish relationships between variables by employing linear algebra while incorporating a regularisation parameter to enhance regression modelling. Users can effectively perform linear regression on datasets, making it a valuable tool for learning and practical data analysis applications. +## Installation +To install the knapsack package from GitLab, follow these steps: +Install the package +You can install the package from GitLab using:<br> +```devtools::install_gitlab("dhana004/group5labbonus", host = "gitlab.liu.se")``` <br><br> +Load the package:<br> +```library(group5labbonus)``` + +### Installing Vignette + +To browse the vignette for this package, follow these steps:<br> +```devtools::build_vignettes()```<br> + +```browseVignettes("group5labbonus")```<br><br> +Note: +The assignment specifies that we should make edits to the Lab 4 Assignment. However, instead of modifying it directly, we created a new package and replicated the process from Lab 4, making the necessary adjustments for the bonus assignment. If you would like to review the original Lab 4 Assignment, please refer to the link provided below: +https://gitlab.liu.se/dhana004/group5lab4assignment ## Authors Manu Jain<br>