aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2016-03-27 16:08:19 -0400
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2016-03-27 16:08:19 -0400
commitbc2c216c3fec3c3859cefb8069f9bf56f60b88c0 (patch)
tree368b17e69e41651e7598cc18cf5e742720dd98d9
parentadd docs to git (diff)
downloadsparsestep-bc2c216c3fec3c3859cefb8069f9bf56f60b88c0.tar.gz
sparsestep-bc2c216c3fec3c3859cefb8069f9bf56f60b88c0.zip
explain use.* are booleans
-rw-r--r--R/sparsestep.R4
1 files changed, 2 insertions, 2 deletions
diff --git a/R/sparsestep.R b/R/sparsestep.R
index b1f9a58..6b47ef7 100644
--- a/R/sparsestep.R
+++ b/R/sparsestep.R
@@ -22,8 +22,8 @@
#' absolute zero
#' @param XX The X'X matrix; useful for repeated runs where X'X stays the same
#' @param Xy The X'y matrix; useful for repeated runs where X'y stays the same
-#' @param use.XX whether or not to compute X'X and return it
-#' @param use.Xy whether or not to compute X'y and return it
+#' @param use.XX whether or not to compute X'X and return it (boolean)
+#' @param use.Xy whether or not to compute X'y and return it (boolean)
#'
#' @return A "sparsestep" S3 object is returned, for which print, predict,
#' coef, and plot methods exist. It has the following items: