aboutsummaryrefslogtreecommitdiff
path: root/man/sparsestep.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'man/sparsestep.Rd')
-rw-r--r--man/sparsestep.Rd15
1 files changed, 4 insertions, 11 deletions
diff --git a/man/sparsestep.Rd b/man/sparsestep.Rd
index b6e836e..f9e1ac3 100644
--- a/man/sparsestep.Rd
+++ b/man/sparsestep.Rd
@@ -1,9 +1,7 @@
% Generated by roxygen2 (4.1.1): do not edit by hand
-% Please edit documentation in R/fit.sparsestep.R, R/sparsestep.R
-\docType{package}
+% Please edit documentation in R/sparsestep.R
\name{sparsestep}
\alias{sparsestep}
-\alias{sparsestep-package}
\title{Fits the SparseStep model}
\usage{
sparsestep(x, y, lambda = c(0.1, 0.5, 1, 5, 10), gamma0 = 1000,
@@ -49,8 +47,8 @@ absolute zero}
\item{use.Xy}{whether or not to compute X'y and return it}
}
\value{
-A "sparsestep" S3 object is returned, for which predict, coef, and
-plot methods exist. It has the following items:
+A "sparsestep" S3 object is returned, for which print, predict,
+coef, and plot methods exist. It has the following items:
\item{call}{The call that was used to construct the model.}
\item{lambda}{The value(s) of lambda used to construct the model.}
\item{gamma0}{The gamma0 value of the model.}
@@ -73,19 +71,14 @@ performed.}
\description{
Fits the SparseStep model for a single value of the
regularization parameter.
-
-sparsestep.
}
\examples{
x <- matrix(rnorm(100*20), 100, 20)
y <- rnorm(100)
fit <- sparsestep(x, y)
}
-\author{
-Gertjan van den Burg (author and maintainer).
-}
\seealso{
\code{\link{coef}}, \code{\link{print}}, \code{\link{predict}},
-\code{\link{plot}}, and \code{\link{sparsestep.path}}.
+\code{\link{plot}}, and \code{\link{path.sparsestep}}.
}