Improve documentation of nsim_obs and obs_prob

R/likelihood.R

@@ -3,9 +3,14 @@
 #' @inheritParams offspring_ll
 #' @inheritParams simulate_summary
 #' @param chains Vector of chain summaries (sizes/lengths)
-#' @param nsim_obs Number of simulations if the log-likelihood/likelihood is to
-#' be approximated for imperfect observations.
-#' @param obs_prob Observation probability (assumed constant)
+#' @param nsim_obs Number of simulations to be used to approximate the
+#' log-likelihood/likelihood if `obs_prob < 1` (imperfect observation). If
+#' `obs_prob == 1`, this argument is ignored.
+#' @param obs_prob Observation probability. A number (probability) between 0
+#' and 1. A value greater than 0 but less 1 implies imperfect observation and
+#' simulations will be used to approximate the (log)likelihood. This will
+#' also require specifying `nsim_obs`. In the simulation, the observation
+#' process is assumed to be constant.
 #' @param log Logical; Should the log-likelihoods be transformed to
 #' likelihoods? (Defaults to TRUE).
 #' @param exclude A vector of indices of the sizes/lengths to exclude from the