Use \describe instead of \itemize in Rd

R/dist_funs.R

@@ -94,23 +94,23 @@
 #' @param method
 #'   Method to specify an internal function (see \dQuote{Details}).  In
 #'   \code{dqfr()}, options are:
-#'   \itemize{
-#'     \item{\code{"broda"}: }{default; uses \code{dqfr_broda()}, numerical
+#'   \describe{
+#'     \item{\code{"broda"}}{default; uses \code{dqfr_broda()}, numerical
 #'           inversion of Broda & Paolella (2009)}
-#'     \item{\code{"hillier"}: }{uses \code{dqfr_A1I1()}, series expression
+#'     \item{\code{"hillier"}}{uses \code{dqfr_A1I1()}, series expression
 #'           of Hillier (2001)}
-#'     \item{\code{"butler"}: }{uses \code{dqfr_butler()}, saddlepoint
+#'     \item{\code{"butler"}}{uses \code{dqfr_butler()}, saddlepoint
 #'           approximation of Butler & Paolella (2007, 2008)}
 #'   }
 #'   In \code{pqfr()}, options are:
-#'   \itemize{
-#'     \item{\code{"imhof"}: }{default; uses \code{pqfr_imhof()}, numerical
+#'   \describe{
+#'     \item{\code{"imhof"}}{default; uses \code{pqfr_imhof()}, numerical
 #'           inversion of Imhof (1961)}
-#'     \item{\code{"davies"}: }{uses \code{pqfr_davies()}, numerical inversion
+#'     \item{\code{"davies"}}{uses \code{pqfr_davies()}, numerical inversion
 #'           of Davies (1973, 1980)}
-#'     \item{\code{"forchini"}: }{uses \code{pqfr_A1B1()}, series expression
+#'     \item{\code{"forchini"}}{uses \code{pqfr_A1B1()}, series expression
 #'           of Forchini (2002, 2005)}
-#'     \item{\code{"butler"}: }{uses \code{pqfr_butler()}, saddlepoint
+#'     \item{\code{"butler"}}{uses \code{pqfr_butler()}, saddlepoint
 #'           approximation of Butler & Paolella (2007, 2008)}
 #'   }
 #' @param trim_values
@@ -173,16 +173,16 @@
 #' (for density and lower \eqn{p}-value, respectively), and only this is passed
 #' to the external function by default.  Other components may be inspected
 #' for debugging purposes:
-#' \itemize{
-#'   \item{\code{dqfr_A1I1()} and \code{pqfr_A1B1()}: }{have \code{$terms},
+#' \describe{
+#'   \item{\code{dqfr_A1I1()} and \code{pqfr_A1B1()}}{have \code{$terms},
 #'      a vector of \eqn{0}th to \eqn{m}th order terms.}
-#'   \item{\code{pqfr_imhof()} and \code{dqfr_broda()}: }{have \code{$abserr},
+#'   \item{\code{pqfr_imhof()} and \code{dqfr_broda()}}{have \code{$abserr},
 #'      absolute error of numerical integration; the one returned from
 #'      \code{CompQuadForm::\link[CompQuadForm]{imhof}()} is divided by
 #'      \code{pi}, as the integration result itself is (internally).  This is
 #'      passed to the external functions when \code{return_abserr_attr = TRUE}
 #'      (above).}
-#'   \item{\code{pqfr_davies()}: }{has the same components as
+#'   \item{\code{pqfr_davies()}}{has the same components as
 #'      \code{CompQuadForm::\link[CompQuadForm]{davies}()} apart from \code{Qq}
 #'      which is replaced by \code{p = 1 - Qq}.}
 #' }

R/dk_funs.R

@@ -818,7 +818,7 @@ dtil3_pqr_v <- function(L1, L2, L3, mu = rep.int(0, n),
 
 
 ##### a1_pk #####
-#' Recursion for a_{p,k}
+#' Recursion for a_\{p,k\}
 #'
 #' \code{a1_pk()} is an internal function to calculate \eqn{a_{p,k}}
 #' (\eqn{a_{r,l}} in Hillier et al. 2014; eq. 24), which is used in the

R/methods_qfrm.R

@@ -32,11 +32,11 @@
 #' the \code{print} and \code{plot} methods.
 #'
 #' The return object is a list of 4 elements which are intended to be:
-#' \itemize{
-#'   \item{\code{$statistic}: }{evaluation result (\code{sum(terms)})}
-#'   \item{\code{$terms}: }{vector of \eqn{0}th to \eqn{m}th order terms}
-#'   \item{\code{$error_bound}: }{error bound of \code{statistic}}
-#'   \item{\code{$seq_error}: }{vector of error bounds corresponding to
+#' \describe{
+#'   \item{\code{$statistic}}{evaluation result (\code{sum(terms)})}
+#'   \item{\code{$terms}}{vector of \eqn{0}th to \eqn{m}th order terms}
+#'   \item{\code{$error_bound}}{error bound of \code{statistic}}
+#'   \item{\code{$seq_error}}{vector of error bounds corresponding to
 #'                              partial sums (\code{cumsum(terms)})}
 #' }
 #' When the result is exact, \code{$terms} can be of length 1 and equal to
@@ -45,14 +45,14 @@
 #' When the relevant flags are provided in the constructor, \code{$error_bound}
 #' and \code{$seq_error} have the following attributes which control behaviors
 #' of the \code{print} and \code{plot} methods:
-#' \itemize{
-#'   \item{\code{"exact"}: }{indicates whether the moment is exact}
-#'   \item{\code{"twosided"}: }{indicates whether the error bounds are
+#' \describe{
+#'   \item{\code{"exact"}}{indicates whether the moment is exact}
+#'   \item{\code{"twosided"}}{indicates whether the error bounds are
 #'                two-sided}
-#'   \item{\code{"alphaout"}: }{indicates whether any of the scaling factors
+#'   \item{\code{"alphaout"}}{indicates whether any of the scaling factors
 #'                (\code{alphaA}, \code{alphaB}, \code{alphaD}) is outside
 #'                \eqn{(0, 1]}, when error bound does not strictly hold}
-#'   \item{\code{"singular"}: }{indicates whether the relevant argument matrix
+#'   \item{\code{"singular"}}{indicates whether the relevant argument matrix
 #'                is (numerically) singular, in which case the error bound is
 #'                invalid}
 #' }

R/qfratio-package.R

@@ -205,14 +205,14 @@ NULL
 #'
 #' @return
 #'   All return a list via \code{Rcpp::List} of the following (as appropriate):
-#'   \itemize{
-#'      \item{\code{$ans}: }{Exact moment, from \code{double} or
+#'   \describe{
+#'      \item{\code{$ans}}{Exact moment, from \code{double} or
 #'                           \code{long double}}
-#'      \item{\code{$ansseq}: }{Series for the moment, from
+#'      \item{\code{$ansseq}}{Series for the moment, from
 #'                              \code{Eigen::Array}}
-#'      \item{\code{$errseq}: }{Series of errors, from \code{Eigen::Array}}
-#'      \item{\code{$twosided}: }{Logical, from \code{bool}}
-#'      \item{\code{$dimnished}: }{Logical, from \code{bool}}
+#'      \item{\code{$errseq}}{Series of errors, from \code{Eigen::Array}}
+#'      \item{\code{$twosided}}{Logical, from \code{bool}}
+#'      \item{\code{$dimnished}}{Logical, from \code{bool}}
 #'   }
 #'
 #' @name qfrm_cpp
@@ -241,10 +241,10 @@ NULL
 #'
 #' @return
 #'   Return a list via \code{Rcpp::List} of the following:
-#'   \itemize{
-#'      \item{\code{$val}: }{Evaluation result, numeric}
-#'      \item{\code{$err}: }{Absolute error, numeric}
-#'      \item{\code{$status}: }{Error code, integer}
+#'   \describe{
+#'      \item{\code{$val}}{Evaluation result, numeric}
+#'      \item{\code{$err}}{Absolute error, numeric}
+#'      \item{\code{$status}}{Error code, integer}
 #'   }
 #'   In \code{hyperg_1F1_vec_b}, these are vectors from
 #'   \code{Rcpp::NumericVector} and \code{Rcpp::IntegerVector}, whereas in

R/ratio_fun.R

@@ -164,29 +164,29 @@
 #' @param cpp_method
 #'   Method used in \proglang{C++} calculations to avoid numerical
 #'   overflow/underflow (see \dQuote{Details}).  Options:
-#'   \itemize{
-#'     \item{\code{"double"}: }{default; fastest but prone to underflow in
+#'   \describe{
+#'     \item{\code{"double"}}{default; fastest but prone to underflow in
 #'           some conditions}
-#'     \item{\code{"long_double"}: }{same algorithm but using the
+#'     \item{\code{"long_double"}}{same algorithm but using the
 #'           \code{long double} variable type; robust but slow and
 #'           memory-inefficient}
-#'     \item{\code{"coef_wise"}: }{coefficient-wise scaling algorithm;
+#'     \item{\code{"coef_wise"}}{coefficient-wise scaling algorithm;
 #'           most robust but variably slow}
 #'    }
 #' @param error_bound
 #'   Logical to specify whether an error bound is returned (if available).
 #' @param check_convergence
 #'   Specifies how numerical convergence is checked (see \dQuote{Details}).
 #'   Options:
-#'   \itemize{
-#'     \item{\code{"relative"}: }{default; magnitude of the last term of
+#'   \describe{
+#'     \item{\code{"relative"}}{default; magnitude of the last term of
 #'           the series relative to the sum is compared with \code{tol_conv}}
-#'     \item{\code{"strict_relative"} or \code{TRUE}: }{same, but stricter than
+#'     \item{\code{"strict_relative"} or \code{TRUE}}{same, but stricter than
 #'           default by setting \code{tol_conv = .Machine$double.eps}
 #'           (unless a smaller value is specified by the user)}
-#'     \item{\code{"absolute"}: }{absolute magnitude of the last term is
+#'     \item{\code{"absolute"}}{absolute magnitude of the last term is
 #'           compared with \code{tol_conv}}
-#'     \item{\code{"none"} or \code{FALSE}: }{skips convergence check}
+#'     \item{\code{"none"} or \code{FALSE}}{skips convergence check}
 #'   }
 #' @param tol_conv
 #'   Tolerance against which numerical convergence of series is checked.  Used
@@ -203,11 +203,11 @@
 #'
 #' @return
 #' A \code{\link[=new_qfrm]{qfrm}} object consisting of the following:
-#' \itemize{
-#'   \item{\code{$statistic}: }{evaluation result (\code{sum(terms)})}
-#'   \item{\code{$terms}: }{vector of \eqn{0}th to \eqn{m}th order terms}
-#'   \item{\code{$error_bound}: }{error bound of \code{statistic}}
-#'   \item{\code{$seq_error}: }{vector of error bounds corresponding to
+#' \describe{
+#'   \item{\code{$statistic}}{evaluation result (\code{sum(terms)})}
+#'   \item{\code{$terms}}{vector of \eqn{0}th to \eqn{m}th order terms}
+#'   \item{\code{$error_bound}}{error bound of \code{statistic}}
+#'   \item{\code{$seq_error}}{vector of error bounds corresponding to
 #'                            partial sums (\code{cumsum(terms)})}
 #'  }
 #'