Skip to content

Commit

Permalink
Update opts.R - fix review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
seabbs authored Aug 28, 2024
1 parent 83f372f commit 93bb8c5
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions R/opts.R
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,9 @@ backcalc_opts <- function(prior = c("reports", "none", "infections"),
#' the expected standard deviation of the logged Rt.
#'
#' @param kernel Character string, the type of kernel required. Currently
#' supporting the Matern kernel ("matern"), squared exponential kernel ("se"), periodic kernel, Ornstein-Uhlenbeck #' kernel ("ou"), and the periodic kernel ("periodic").
#' supporting the Matern kernel ("matern"), squared exponential kernel ("se"),
#' periodic kernel, Ornstein-Uhlenbeck #' kernel ("ou"), and the periodic
#' kernel ("periodic").
#'

Check warning on line 432 in R/opts.R

View workflow job for this annotation

GitHub Actions / lint-changed-files

file=R/opts.R,line=432,col=3,[trailing_whitespace_linter] Trailing whitespace is superfluous.
#'
#' @param matern_order Numeric, defaults to 3/2. Order of Matérn Kernel to use.
Expand All @@ -435,9 +437,9 @@ backcalc_opts <- function(prior = c("reports", "none", "infections"),
#' the kernel is set to "matern".
#'
#' @param matern_type Deprecated; Numeric, defaults to 3/2. Order of Matérn
#' Kernel to use. Currently the orders 1/2, 3/2, 5/2 and Inf are supported.
#' Kernel to use. Currently, the orders 1/2, 3/2, 5/2 and Inf are supported.
#'
#' @param basis_prop Numeric, proportion of time points to use as basis
#' @param basis_prop Numeric, the proportion of time points to use as basis
#' functions. Defaults to 0.2. Decreasing this value results in a decrease in
#' accuracy but a faster compute time (with increasing it having the first
#' effect). In general smaller posterior length scales require a higher
Expand All @@ -449,7 +451,7 @@ backcalc_opts <- function(prior = c("reports", "none", "infections"),
#' <https://arxiv.org/abs/2004.11408>) for advice on updating this default.
#'
#' @param w0 Numeric, defaults to 1.0. Fundamental frequency for periodic
#' kernel. Only used if `kernel` is set to "periodic".
#' kernel. They are only used if `kernel` is set to "periodic".
#'
#' @importFrom rlang arg_match
#' @return A `<gp_opts>` object of settings defining the Gaussian process
Expand Down

0 comments on commit 93bb8c5

Please sign in to comment.