aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2016-02-10 22:30:25 -0500
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2016-02-10 22:30:25 -0500
commitb3dd58bb7fe53cc072dea36b1bb3702703836a49 (patch)
tree86f91107663ef3b6a8e25c918dc5ca8c184767e3
parentbugfixes, documentation improvements, and generic function agreement (diff)
downloadsparsestep-b3dd58bb7fe53cc072dea36b1bb3702703836a49.tar.gz
sparsestep-b3dd58bb7fe53cc072dea36b1bb3702703836a49.zip
minor formatting fixes
-rw-r--r--DESCRIPTION10
-rw-r--r--R/coef.sparsestep.R4
-rw-r--r--R/plot.sparsestep.R2
-rw-r--r--R/predict.sparsestep.R7
-rw-r--r--R/print.sparsestep.R4
-rw-r--r--man/print.sparsestep.Rd4
6 files changed, 15 insertions, 16 deletions
diff --git a/DESCRIPTION b/DESCRIPTION
index 1fb6939..56fbe40 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -2,12 +2,10 @@ Package: sparsestep
Type: Package
Title: SparseStep Regression
Version: 0.1
-Authors@R: c(person("Gertjan", "van den Burg", email="sparsestep@gmail.com",
- role=c("aut", "cre")), person("Andreas", "Alfons",
-email="alfons@ese.eur.nl", role="ctb"), person("Patrick, "Groenen",
-email="groenen@ese.eur.nl", role="ctb"))
-Author: Gertjan van den Burg [aut, cre], Andreas Alfons [ctb], Patrick Groenen
-[ctb]
+Authors@R: c(person("Gertjan", "van den Burg", email="sparsestep@gmail.com", role=c("aut", "cre")),
+ person("Andreas", "Alfons", email="alfons@ese.eur.nl", role="ctb"),
+ person("Patrick", "Groenen", email="groenen@ese.eur.nl", role="ctb"))
+Author: Gertjan van den Burg [aut, cre], Andreas Alfons [ctb], Patrick Groenen [ctb]
Maintainer: Gertjan van den Burg <sparsestep@gmail.com>
Description: Implements the SparseStep regression model.
Depends: Matrix (>= 1.0-6)
diff --git a/R/coef.sparsestep.R b/R/coef.sparsestep.R
index 713bcb2..93072da 100644
--- a/R/coef.sparsestep.R
+++ b/R/coef.sparsestep.R
@@ -2,8 +2,8 @@
#'
#' @description Returns the coefficients of the SparseStep model.
#'
-#' @param object a "sparsestep" object
-#' @param ... further argument are ignored
+#' @param object a \code{sparsestep} object
+#' @param \dots further argument are ignored
#'
#' @return The coefficients of the SparseStep model (i.e. the betas). If the
#' model was fitted with an intercept this will be the first value in the
diff --git a/R/plot.sparsestep.R b/R/plot.sparsestep.R
index 336a36b..cac7137 100644
--- a/R/plot.sparsestep.R
+++ b/R/plot.sparsestep.R
@@ -3,7 +3,7 @@
#' @description Plot the coefficients of the SparseStep path
#'
#' @param x a \code{sparsestep} object
-#' @param ... further argument to matplot
+#' @param \dots further argument to matplot
#'
#' @export
#' @aliases plot
diff --git a/R/predict.sparsestep.R b/R/predict.sparsestep.R
index b2ebd77..065bc6b 100644
--- a/R/predict.sparsestep.R
+++ b/R/predict.sparsestep.R
@@ -3,9 +3,10 @@
#' @description Predicts the outcome variable for the SparseStep model for
#' each value of lambda supplied to the model.
#'
-#' @param object Fitted "sparsestep" object
-#' @param newx Matrix of new values for `x` at which predictions are to be made.
-#' @param ... further argument are ignored
+#' @param object Fitted \code{sparsestep} object
+#' @param newx Matrix of new values for \code{x} at which predictions are to
+#' be made.
+#' @param \dots further argument are ignored
#'
#' @return a matrix of numerical predictions of size nobs x nlambda
#'
diff --git a/R/print.sparsestep.R b/R/print.sparsestep.R
index 549815b..2c987a2 100644
--- a/R/print.sparsestep.R
+++ b/R/print.sparsestep.R
@@ -2,8 +2,8 @@
#'
#' @description Prints a short text of a fitted SparseStep model
#'
-#' @param x a "sparsestep" object to print
-#' @param ... further argument are ignored
+#' @param x a \code{sparsestep} object to print
+#' @param \dots further argument are ignored
#'
#' @export
#'
diff --git a/man/print.sparsestep.Rd b/man/print.sparsestep.Rd
index 7e3d9bb..4d194b5 100644
--- a/man/print.sparsestep.Rd
+++ b/man/print.sparsestep.Rd
@@ -8,9 +8,9 @@
\method{print}{sparsestep}(x, ...)
}
\arguments{
-\item{x}{a "sparsestep" object to print}
+\item{x}{a \code{sparsestep} object to print}
-\item{...}{further argument are ignored}
+\item{\dots}{further argument are ignored}
}
\description{
Prints a short text of a fitted SparseStep model