From 423ac41d2e379a51fc5b7c446424f02f884c58ba Mon Sep 17 00:00:00 2001
From: daniel <daniel@kapla.at>
Date: Fri, 20 Dec 2019 09:41:27 +0100
Subject: [PATCH] - wip: reviewing and fixing doc.

---
 CVE/R/datasets.R       | 2 +-
 CVE/R/summary.R        | 3 ++-
 CVE/man/dataset.Rd     | 2 +-
 CVE/man/summary.cve.Rd | 3 ++-
 4 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/CVE/R/datasets.R b/CVE/R/datasets.R
index 14556ef..b519a36 100644
--- a/CVE/R/datasets.R
+++ b/CVE/R/datasets.R
@@ -200,7 +200,7 @@ rlaplace <- function(n = 1, mu = 0, sd = 1) {
 #' location 0, shape-parameter 1, and the scale-parameter is chosen such that
 #' \eqn{Var(\epsilon) = 0.25}.
 #'
-#' @references Fertl Lukas, Bura Efstathia. (2019), Conditional Variance
+#' @references Fertl, L. and Bura, E. (2019), Conditional Variance
 #' Estimation for Sufficient Dimension Reduction. Working Paper.
 #'
 #' @import stats
diff --git a/CVE/R/summary.R b/CVE/R/summary.R
index 90a9cfe..84588b0 100644
--- a/CVE/R/summary.R
+++ b/CVE/R/summary.R
@@ -3,7 +3,8 @@
 #' Prints a summary statistics of output \code{L} from \code{cve} for
 #' \code{k = min.dim, ..., max.dim}.
 #'
-#' @param object Instance of \code{"cve"} as returned by \code{\link{cve}}.
+#' @param object an object of class \code{"cve"}, usually, a result of a call to
+#'          \code{\link{cve}} or \code{\link{cve.call}}.
 #' @param ... ignored.
 #'
 #' @examples
diff --git a/CVE/man/dataset.Rd b/CVE/man/dataset.Rd
index 69999bd..89c77ef 100644
--- a/CVE/man/dataset.Rd
+++ b/CVE/man/dataset.Rd
@@ -122,6 +122,6 @@ location 0, shape-parameter 1, and the scale-parameter is chosen such that
 }
 
 \references{
-Fertl Lukas, Bura Efstathia. (2019), Conditional Variance
+Fertl, L. and Bura, E. (2019), Conditional Variance
 Estimation for Sufficient Dimension Reduction. Working Paper.
 }
diff --git a/CVE/man/summary.cve.Rd b/CVE/man/summary.cve.Rd
index 3c46043..258c4ab 100644
--- a/CVE/man/summary.cve.Rd
+++ b/CVE/man/summary.cve.Rd
@@ -7,7 +7,8 @@
 \method{summary}{cve}(object, ...)
 }
 \arguments{
-\item{object}{Instance of \code{"cve"} as returned by \code{\link{cve}}.}
+\item{object}{an object of class \code{"cve"}, usually, a result of a call to
+\code{\link{cve}} or \code{\link{cve.call}}.}
 
 \item{...}{ignored.}
 }