Skip to content

Commit

Permalink
make indentation consistent
Browse files Browse the repository at this point in the history
  • Loading branch information
sbfnk committed Feb 14, 2024
1 parent 5638025 commit 97e887e
Showing 1 changed file with 11 additions and 16 deletions.
27 changes: 11 additions & 16 deletions R/opts.R
Original file line number Diff line number Diff line change
Expand Up @@ -427,31 +427,26 @@ gp_opts <- function(basis_prop = 0.2,
#' Defines a list specifying the structure of the observation
#' model. Custom settings can be supplied which override the defaults.
#' @param family Character string defining the observation model. Options are
#' Negative binomial ("negbin"), the default, and Poisson.
#' @param phi A numeric vector of length 2, defaults to 0, 1. Indicates the
#' mean and standard deviation of the normal prior used for the observation
#' process.
#'
#' @param weight Numeric, defaults to 1. Weight to give the observed data in
#' the log density.
#' Negative binomial ("negbin"), the default, and Poisson.
#' @param phi A numeric vector of length 2, defaults to 0, 1. Indicates the mean
#' and standard deviation of the normal prior used for the observation
#' process.
#' @param weight Numeric, defaults to 1. Weight to give the observed data in the
#' log density.
#' @param week_effect Logical defaulting to `TRUE`. Should a day of the week
#' effect be used in the observation model.
#'
#' effect be used in the observation model.
#' @param week_length Numeric assumed length of the week in days, defaulting to
#' 7 days. This can be modified if data aggregated over a period other than a
#' week or if data has a non-weekly periodicity.
#'
#' 7 days. This can be modified if data aggregated over a period other than a
#' week or if data has a non-weekly periodicity.
#' @param scale Defaults to 1. Should an scaling factor be applied to
#' map latent infections (convolved to date of report). Can be supplied either
#' as a single numeric value (fixed scale) or a list with numeric elements
#' mean (`mean`) and standard deviation (`sd`) defining a normally
#' distributed scaling factor.
#'
#' @param likelihood Logical, defaults to `TRUE`. Should the likelihood be
#' included in the model.
#'
#' included in the model.
#' @param return_likelihood Logical, defaults to `FALSE`. Should the likelihood
#' be returned by the model.
#' be returned by the model.
#' @importFrom rlang arg_match
#'
#' @return An `<obs_opts>` object of observation model settings.
Expand Down

0 comments on commit 97e887e

Please sign in to comment.