Explain init better

paulnorthrop · Feb 27, 2024 · a8955c8 · a8955c8
1 parent b93f78f
commit a8955c8
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 2 deletions.
diff --git a/R/ru_sampling.R b/R/ru_sampling.R
@@ -29,6 +29,8 @@
 #'   Box-Cox transformation or user-defined transformation, but \emph{before}
 #'   any rotation of axes.
 #'   If \code{init} is not supplied then \code{rep(1, d)} is used.
+#'   If \code{length(init) = 1} and \code{d > 1} then
+#'   \code{init <- rep(init, length.out = d)} is used.
 #' @param mode A numeric vector of length \code{d}.  The mode of \code{logf}.
 #'   If \code{trans = "BC"} or \code{trans = "user"} this is \emph{after}
 #'   Box-Cox transformation or user-defined transformation, but \emph{before}

diff --git a/R/ru_sampling_rcpp.R b/R/ru_sampling_rcpp.R
@@ -40,6 +40,8 @@
 #'   Box-Cox transformation or user-defined transformation, but \emph{before}
 #'   any rotation of axes.
 #'   If \code{init} is not supplied then \code{rep(1, d)} is used.
+#'   If \code{length(init) = 1} and \code{d > 1} then
+#'   \code{init <- rep(init, length.out = d)} is used.
 #' @param mode A numeric vector of length \code{d}.  The mode of \code{logf}.
 #'   If \code{trans = "BC"} or \code{trans = "user"} this is \emph{after}
 #'   Box-Cox transformation or user-defined transformation, but \emph{before}

diff --git a/man/ru.Rd b/man/ru.Rd
diff --git a/man/ru_rcpp.Rd b/man/ru_rcpp.Rd