diff --git a/NEWS.md b/NEWS.md index 6b019bb..baaa119 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,11 @@ +# rust 1.4.2 + +## Bug fixes and minor improvements + +* The issue described at https://github.com/RcppCore/Rcpp/issues/1287 has been fixed to avoid WARNINGs from CRAN checks on some platforms. Thank you to Dirk Eddelbuettel for providing the fix so quickly! + +* Fixed issues with the incorrect use of \itemize in some Rd files. + # rust 1.4.1 ## Bug fixes and minor improvements diff --git a/R/ru_sampling.R b/R/ru_sampling.R index 0c7d42a..d23b774 100644 --- a/R/ru_sampling.R +++ b/R/ru_sampling.R @@ -62,8 +62,8 @@ #' functions \code{phi_to_theta} and \code{log_j}. #' @param lambda Either #' \itemize{ -#' \item {A numeric vector. Box-Cox transformation parameters, or} -#' \item {A list with components} +#' \item A numeric vector. Box-Cox transformation parameters, or +#' \item A list with components #' \describe{ #' \item{lambda}{A numeric vector. Box-Cox parameters (required).} #' \item{gm}{A numeric vector. Box-cox scaling parameters (optional). diff --git a/R/ru_sampling_rcpp.R b/R/ru_sampling_rcpp.R index 57020a3..77a8c0b 100644 --- a/R/ru_sampling_rcpp.R +++ b/R/ru_sampling_rcpp.R @@ -74,8 +74,8 @@ #' functions \code{phi_to_theta} and \code{log_j}. #' @param lambda Either #' \itemize{ -#' \item {A numeric vector. Box-Cox transformation parameters, or} -#' \item {A list with components} +#' \item A numeric vector. Box-Cox transformation parameters, or +#' \item A list with components #' \describe{ #' \item{lambda}{A numeric vector. Box-Cox parameters (required).} #' \item{gm}{A numeric vector. Box-cox scaling parameters (optional). diff --git a/R/rust-package.R b/R/rust-package.R index 2fb79bd..6f3bcdd 100644 --- a/R/rust-package.R +++ b/R/rust-package.R @@ -19,20 +19,20 @@ #' #' See the following package vignettes for information: #' \itemize{ -#' \item{ +#' \item #' \href{https://paulnorthrop.github.io/rust/articles/rust-a-vignette.html}{ #' Introducing rust} or \code{vignette("rust-a-vignette", package = "rust")}. -#' } -#' \item{ +#' +#' \item #' \href{https://paulnorthrop.github.io/rust/articles/rust-b-when-to-use-vignette.html}{ #' When can rust be used?} or #' \code{vignette("rust-b-when-to-use-vignette", package = "rust")}. -#' } -#' \item{ +#' +#' \item #' \href{https://paulnorthrop.github.io/rust/articles/rust-c-using-rcpp-vignette.html}{ #' Rusting faster: Simulation using Rcpp} or #' \code{vignette("rust-c-using-rcpp-vignette", package = "rust")}. -#' } +#' #' } #' #' @references Wakefield, J. C., Gelfand, A. E. and Smith, A. F. M. Efficient diff --git a/R/sample_diagnostics.R b/R/sample_diagnostics.R index 9788c38..ec24b8d 100644 --- a/R/sample_diagnostics.R +++ b/R/sample_diagnostics.R @@ -16,9 +16,9 @@ #' @param n A numeric scalar. Only relevant if \code{x$d = 1} or #' \code{x$d = 2}. The meaning depends on the value of x$d. #' \itemize{ -#' \item {For d = 1 : n + 1 is the number of abscissae in the trapezium -#' method used to normalize the density.} -#' \item {For d = 2 : an n by n regular grid is used to contour the density.} +#' \item For d = 1 : n + 1 is the number of abscissae in the trapezium +#' method used to normalize the density. +#' \item For d = 2 : an n by n regular grid is used to contour the density. #' } #' @param prob Numeric vector. Only relevant for \code{d = 2}. The contour #' lines are drawn such that the respective probabilities that the variable @@ -224,12 +224,12 @@ plot.ru <- function(x, y, ..., n = ifelse(x$d == 1, 1001, 101), #' @return For \code{summary.lm}: a list of the following components from #' \code{object}: #' \itemize{ -#' \item {information about the ratio-of-uniforms bounding box, i.e., -#' \code{object$box}} -#' \item {an estimate of the probability of acceptance, i.e., -#' \code{object$pa}} -#' \item {a summary of the simulated values, via -#' \code{summary(object$sim_vals)}} +#' \item information about the ratio-of-uniforms bounding box, i.e., +#' \code{object$box} +#' \item an estimate of the probability of acceptance, i.e., +#' \code{object$pa} +#' \item a summary of the simulated values, via +#' \code{summary(object$sim_vals)} #' } #' @examples #' # one-dimensional standard normal ---------------- diff --git a/man/plot.ru.Rd b/man/plot.ru.Rd index 35d4ef2..a0d0a10 100644 --- a/man/plot.ru.Rd +++ b/man/plot.ru.Rd @@ -29,9 +29,9 @@ \item{n}{A numeric scalar. Only relevant if \code{x$d = 1} or \code{x$d = 2}. The meaning depends on the value of x$d. \itemize{ - \item {For d = 1 : n + 1 is the number of abscissae in the trapezium - method used to normalize the density.} - \item {For d = 2 : an n by n regular grid is used to contour the density.} + \item For d = 1 : n + 1 is the number of abscissae in the trapezium + method used to normalize the density. + \item For d = 2 : an n by n regular grid is used to contour the density. }} \item{prob}{Numeric vector. Only relevant for \code{d = 2}. The contour diff --git a/man/ru.Rd b/man/ru.Rd index 5b2e921..39f6a89 100644 --- a/man/ru.Rd +++ b/man/ru.Rd @@ -99,8 +99,8 @@ functions \code{phi_to_theta} and \code{log_j}.} \item{lambda}{Either \itemize{ - \item {A numeric vector. Box-Cox transformation parameters, or} - \item {A list with components} + \item A numeric vector. Box-Cox transformation parameters, or + \item A list with components \describe{ \item{lambda}{A numeric vector. Box-Cox parameters (required).} \item{gm}{A numeric vector. Box-cox scaling parameters (optional). diff --git a/man/ru_rcpp.Rd b/man/ru_rcpp.Rd index 51b5d37..e58934c 100644 --- a/man/ru_rcpp.Rd +++ b/man/ru_rcpp.Rd @@ -108,8 +108,8 @@ functions \code{phi_to_theta} and \code{log_j}.} \item{lambda}{Either \itemize{ - \item {A numeric vector. Box-Cox transformation parameters, or} - \item {A list with components} + \item A numeric vector. Box-Cox transformation parameters, or + \item A list with components \describe{ \item{lambda}{A numeric vector. Box-Cox parameters (required).} \item{gm}{A numeric vector. Box-cox scaling parameters (optional). diff --git a/man/rust-package.Rd b/man/rust-package.Rd index 7157ac8..c10beb9 100644 --- a/man/rust-package.Rd +++ b/man/rust-package.Rd @@ -24,20 +24,20 @@ The main functions in the rust package are \code{\link{ru}} and See the following package vignettes for information: \itemize{ - \item{ + \item \href{https://paulnorthrop.github.io/rust/articles/rust-a-vignette.html}{ Introducing rust} or \code{vignette("rust-a-vignette", package = "rust")}. - } - \item{ + + \item \href{https://paulnorthrop.github.io/rust/articles/rust-b-when-to-use-vignette.html}{ When can rust be used?} or \code{vignette("rust-b-when-to-use-vignette", package = "rust")}. - } - \item{ + + \item \href{https://paulnorthrop.github.io/rust/articles/rust-c-using-rcpp-vignette.html}{ Rusting faster: Simulation using Rcpp} or \code{vignette("rust-c-using-rcpp-vignette", package = "rust")}. - } + } } \references{ diff --git a/man/summary.ru.Rd b/man/summary.ru.Rd index b8ca2a5..843a26c 100644 --- a/man/summary.ru.Rd +++ b/man/summary.ru.Rd @@ -25,12 +25,12 @@ For \code{print.lm}: additional optional arguments passed to For \code{summary.lm}: a list of the following components from \code{object}: \itemize{ - \item {information about the ratio-of-uniforms bounding box, i.e., - \code{object$box}} - \item {an estimate of the probability of acceptance, i.e., - \code{object$pa}} - \item {a summary of the simulated values, via - \code{summary(object$sim_vals)}} + \item information about the ratio-of-uniforms bounding box, i.e., + \code{object$box} + \item an estimate of the probability of acceptance, i.e., + \code{object$pa} + \item a summary of the simulated values, via + \code{summary(object$sim_vals)} } For \code{print.summary.ru}: the argument \code{x}, invisibly.