- wip: reviewing and fixing doc.

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

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

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.
 }

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.}
 }