From 3065fb6c01b5b12f36e2aadd4ad3da8b9624f8bc Mon Sep 17 00:00:00 2001 From: Sebastian Funk Date: Wed, 14 Feb 2024 21:51:44 +0000 Subject: [PATCH] improve documentation of scale parameter --- R/opts.R | 10 +++++----- man/obs_opts.Rd | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/R/opts.R b/R/opts.R index cdfafab7c..d0bf688ad 100644 --- a/R/opts.R +++ b/R/opts.R @@ -438,11 +438,11 @@ gp_opts <- function(basis_prop = 0.2, #' @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. -#' @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 scale Scaling factor to 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. Defaults to 1, i.e. +#' no scaling. #' @param na Character. Options are "missing" (the default) and "accumulate". #' This determines how NA values in the data are interpreted. If set to #' "missing", any NA values in the observation data set will be interpreted as diff --git a/man/obs_opts.Rd b/man/obs_opts.Rd index b9f5d8f40..05221d53d 100644 --- a/man/obs_opts.Rd +++ b/man/obs_opts.Rd @@ -34,11 +34,11 @@ effect be used in the observation model.} 7 days. This can be modified if data aggregated over a period other than a week or if data has a non-weekly periodicity.} -\item{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 (\code{mean}) and standard deviation (\code{sd}) defining a normally -distributed scaling factor.} +\item{scale}{Scaling factor to 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 (\code{mean}) and standard deviation +(\code{sd}) defining a normally distributed scaling factor. Defaults to 1, i.e. +no scaling.} \item{na}{Character. Options are "missing" (the default) and "accumulate". This determines how NA values in the data are interpreted. If set to