edit in documentation

DESCRIPTION

@@ -5,7 +5,7 @@ Version: 1.0
 Date: 2024-11-03
 Author: Manu Jain [aut], Dhanush Kumar Reddy Narayana Reddy [cre]
 Maintainer: Dhanush Kumar Reddy Narayana Reddy to <dhana004@student.liu.se>
-Description: More about what it does (maybe more than one line).
+Description: A package for fitting ridge regression models with methods for model initialization, coefficient extraction, prediction, and model summary printing. The package is designed for educational and data analysis purposes, providing straightforward access to ridge regression for regression modeling with a regularization parameter.
 License: GPL-3 + file LICENSE
 Imports: 
     methods

man/group5labbonus-package.Rd

@@ -9,6 +9,7 @@
 \packageDescription{group5labbonus}
 }
 \details{
+The \code{group5labbonus} package provides fitting ridge regression models with methods for model initialization, coefficient extraction, prediction, and model summary printing. The package is designed for educational and data analysis purposes, providing straightforward access to ridge regression for regression modeling with a regularization parameter.
 %%  ~~ An overview of how to use the package, ~~
 %%  ~~ including the most important functions ~~
 }
@@ -18,6 +19,7 @@
 Maintainer: \packageMaintainer{group5labbonus}
 }
 \references{
+For more information, see \url{https://en.wikipedia.org/wiki/Ridge_regression}
 %%  ~~ Literature or other references for background information ~~
 }
 \keyword{package}
@@ -27,9 +29,12 @@ Maintainer: \packageMaintainer{group5labbonus}
 %\section{Documentation Index}{\packageIndices{group5labbonus}}
 
 \seealso{
+\code{\link{ridgereg}}
 %%  ~~ Optional links to other man pages, e.g. ~~
 %%  ~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~
 }
 \examples{
+data(iris)
+model <- ridgereg$new(Sepal.Length ~ Sepal.Width + Petal.Length, data = iris, lambda = 0.1)
 %%  ~~ Optional simple examples of the most important functions ~~
 }