update docs for coef and predict methods

nvrivera · May 2, 2018 · d29bb56 · d29bb56
1 parent 9460e90
commit d29bb56
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 0 deletions.
diff --git a/R/predict.susie.R b/R/predict.susie.R
@@ -1,10 +1,17 @@
+#' @title extract regression coefficients from susie fit
 #' @param s a susie fit
 #' @return a p vector of estimated regression coefficients
+#' @method coef susie
 #' @export
 coef.susie = function(s){
   colSums(s$alpha*s$mu)
 }
 
+#' @title predict future observations or extract coefficients from susie fit
+#' @param s a susie fit
+#' @param newx a new value for X at which to do predictions
+#' @param type if this is coefficients, then calls coef.susie
+#' @method predict susie
 #' @export
 predict.susie = function(s,newx = NULL,type=c("response","coefficients")){
   type <- match.arg(type)

diff --git a/man/coef.susie.Rd b/man/coef.susie.Rd
diff --git a/man/predict.susie.Rd b/man/predict.susie.Rd