Add author and reference to each public method documentation

7 files changed, 65 insertions, 2 deletions

diff --git a/R/coef.sparsestep.R b/R/coef.sparsestep.R
index 93072da..567b1f0 100644
--- a/R/coef.sparsestep.R
+++ b/R/coef.sparsestep.R
@@ -8,6 +8,15 @@
 #' @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
 #' resulting vector.
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  arXiv preprint arXiv:1701.06967 [stat.ME]. 
+#'  URL \url{https://arxiv.org/abs/1701.06967}.
 #'
 #' @export
 #' @aliases coef
diff --git a/R/path.sparsestep.R b/R/path.sparsestep.R
index 6f013e0..429526f 100644
--- a/R/path.sparsestep.R
+++ b/R/path.sparsestep.R
@@ -59,6 +59,15 @@
 #'
 #' @export
 #'
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  arXiv preprint arXiv:1701.06967 [stat.ME]. 
+#'  URL \url{https://arxiv.org/abs/1701.06967}.
 #' @seealso
 #' \code{\link{coef}}, \code{\link{print}}, \code{\link{predict}}, 
 #' \code{\link{plot}}, and \code{\link{sparsestep}}.
diff --git a/R/plot.sparsestep.R b/R/plot.sparsestep.R
index cac7137..09c146e 100644
--- a/R/plot.sparsestep.R
+++ b/R/plot.sparsestep.R
@@ -5,6 +5,16 @@
 #' @param x a \code{sparsestep} object
 #' @param \dots further argument to matplot
 #'
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  arXiv preprint arXiv:1701.06967 [stat.ME]. 
+#'  URL \url{https://arxiv.org/abs/1701.06967}.
+#'
 #' @export
 #' @aliases plot
 #'
diff --git a/R/predict.sparsestep.R b/R/predict.sparsestep.R
index 065bc6b..c0c4f4b 100644
--- a/R/predict.sparsestep.R
+++ b/R/predict.sparsestep.R
@@ -13,6 +13,16 @@
 #' @export
 #' @aliases predict
 #'
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  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)
diff --git a/R/print.sparsestep.R b/R/print.sparsestep.R
index 2c987a2..9d22324 100644
--- a/R/print.sparsestep.R
+++ b/R/print.sparsestep.R
@@ -5,9 +5,17 @@
 #' @param x a \code{sparsestep} object to print
 #' @param \dots further argument are ignored
 #'
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  arXiv preprint arXiv:1701.06967 [stat.ME]. 
+#'  URL \url{https://arxiv.org/abs/1701.06967}.
 #' @export
 #'
-#' @aliases print
 #'
 #' @examples
 #' x <- matrix(rnorm(100*20), 100, 20)
diff --git a/R/sparsestep-package.R b/R/sparsestep-package.R
index 303544b..c1c5361 100644
--- a/R/sparsestep-package.R
+++ b/R/sparsestep-package.R
@@ -29,7 +29,14 @@
 #' }
 #'
 #' @author
-#' Gertjan van den Burg (author and maintainer).
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  arXiv preprint arXiv:1701.06967 [stat.ME]. 
+#'  URL \url{https://arxiv.org/abs/1701.06967}.
 #'
 #' @name sparsestep-package
 #' @docType package
diff --git a/R/sparsestep.R b/R/sparsestep.R
index 6b47ef7..ef4ab22 100644
--- a/R/sparsestep.R
+++ b/R/sparsestep.R
@@ -46,6 +46,16 @@
 #' \item{XX}{The matrix X'X if use.XX was set to TRUE}
 #' \item{Xy}{The matrix X'y if use.Xy was set to TRUE}
 #'
+#' @author
+#' Gerrit J.J. van den Burg, Patrick J.F. Groenen, Andreas Alfons\cr
+#' Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
+#'
+#' @references
+#' Van den Burg, G.J.J., Groenen, P.J.F. and Alfons, A. (2017).
+#'  \emph{SparseStep: Approximating the Counting Norm for Sparse Regularization},
+#'  arXiv preprint arXiv:1701.06967 [stat.ME]. 
+#'  URL \url{https://arxiv.org/abs/1701.06967}.
+#'
 #' @seealso
 #' \code{\link{coef}}, \code{\link{print}}, \code{\link{predict}}, 
 #' \code{\link{plot}}, and \code{\link{path.sparsestep}}.