aboutsummaryrefslogtreecommitdiff
path: root/R/sparsestep-package.R
diff options
context:
space:
mode:
authorGertjan van den Burg <burg@ese.eur.nl>2017-01-25 14:03:38 +0100
committerGertjan van den Burg <burg@ese.eur.nl>2017-01-25 14:03:38 +0100
commit96e7bc6fdf292c7f73e599dae0b7957161e15212 (patch)
tree1bedb98795b657ce51be2a6a79da7fe69435b00a /R/sparsestep-package.R
parentAdd author and reference to each public method documentation (diff)
downloadsparsestep-96e7bc6fdf292c7f73e599dae0b7957161e15212.tar.gz
sparsestep-96e7bc6fdf292c7f73e599dae0b7957161e15212.zip
Various documentation fixes
Diffstat (limited to 'R/sparsestep-package.R')
-rw-r--r--R/sparsestep-package.R10
1 files changed, 10 insertions, 0 deletions
diff --git a/R/sparsestep-package.R b/R/sparsestep-package.R
index c1c5361..97fcd5b 100644
--- a/R/sparsestep-package.R
+++ b/R/sparsestep-package.R
@@ -38,6 +38,16 @@
#' arXiv preprint arXiv:1701.06967 [stat.ME].
#' URL \url{https://arxiv.org/abs/1701.06967}.
#'
+#' @examples
+#' x <- matrix(rnorm(100*20), 100, 20)
+#' y <- rnorm(100)
+#' fit <- sparsestep(x, y)
+#' plot(fit)
+#' fits <- path.sparsestep(x, y)
+#' plot(fits)
+#' x2 <- matrix(rnorm(50*20), 50, 20)
+#' y2 <- predict(fits, x2)
+#'
#' @name sparsestep-package
#' @docType package
#' @import Matrix