Skip to content

Commit

Permalink
Replaced \itemize with \describe where needed
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewzm committed Oct 18, 2023
1 parent a553da8 commit 66546ff
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,6 @@ Additional_repositories: https://andrewzm.github.io/dggrids-repo/,
License: GPL (>= 2)
NeedsCompilation: yes
LazyData: true
RoxygenNote: 7.2.2
RoxygenNote: 7.2.3
LinkingTo: Rcpp, TMB, RcppEigen
Encoding: UTF-8
2 changes: 1 addition & 1 deletion R/SRE.R
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@
#' or Case 2 is chosen; see the vignette "FRK_intro") and the regression parameters \ifelse{html}{\out{<i> <b>&alpha;</b> </i>}}{\eqn{\boldsymbol{\alpha}}{\alpha}}.
#' There are two methods of model fitting currently implemented, both of which
#' implement maximum likelihood estimation (MLE).
#' \itemize{
#' \describe{
#' \item{MLE via the expectation maximisation
#' (EM) algorithm. }{This method is implemented only
#' for Gaussian data and an identity link function.
Expand Down
4 changes: 2 additions & 2 deletions R/options.R
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,12 @@ new_opts_FRK <- function(d = list(progress = TRUE, verbose = FALSE, parallel=1L)
#' @title FRK options
#' @description The main options list for the FRK package.
#' @format List of 2
#' \itemize{
#' \describe{
#' \item{\code{$} }{\code{set:function(opt,value)}}
#' \item{\code{$} }{\code{get:function(opt)}}
#' }
#' @details \code{opts_FRK} is a list containing two functions, \code{set} and \code{get}, which can be used to set options and retrieve options, respectively. Currently \code{FRK} uses three options:
#' \itemize{
#' \describe{
#' \item{"progress":}{ a flag indicating whether progress bars should be displayed or not}
#' \item{"verbose":}{ a flag indicating whether certain progress messages should be shown or not. Currently this is the only option applicable to \code{method} = "TMB"}
#' \item{"parallel":}{ an integer indicating the number of cores to use. A number 0 or 1 indicates no parallelism}
Expand Down
2 changes: 1 addition & 1 deletion man/SRE.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/opts_FRK.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 66546ff

Please sign in to comment.