From 71a71333fe53e15ecf74b5da308f9955542a72ff Mon Sep 17 00:00:00 2001 From: "Aaron A. King" Date: Wed, 8 Jan 2025 15:24:54 -0500 Subject: [PATCH] improve documentation --- DESCRIPTION | 4 ++-- R/eulermultinom.R | 5 +++++ man/eulermultinom.Rd | 5 +++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index cf3cd3d3..0d9475a8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Package: pomp Type: Package Title: Statistical Inference for Partially Observed Markov Processes -Version: 6.0.5.0 -Date: 2025-01-05 +Version: 6.0.5.1 +Date: 2025-01-08 Authors@R: c(person(given=c("Aaron","A."),family="King",role=c("aut","cre"),email="kingaa@umich.edu",comment=c(ORCID="0000-0001-6159-3207")), person(given=c("Edward","L."),family="Ionides",role="aut",comment=c(ORCID="0000-0002-4190-0174")) , person(given="Carles",family="Bretó",role="aut",comment=c(ORCID="0000-0003-4695-4902")), diff --git a/R/eulermultinom.R b/R/eulermultinom.R index 7aeca894..766d38c7 100644 --- a/R/eulermultinom.R +++ b/R/eulermultinom.R @@ -98,6 +98,11 @@ deulermultinom <- function (x, size, rate, dt, log = FALSE) { ##' @return ##' \code{eeulermultinom} returns a \code{length(rate)}-vector ##' containing the expected number of individuals to have succumbed to the corresponding process. +##' With the notation above, if +##' \preformatted{ +##' dn <- eeulermultinom(size=N,rate=r,dt=dt), +##' } +##' then the \eqn{k}-th element of the vector \code{dn} will be \eqn{p_k N}{pk N}. ##' @export eeulermultinom <- function (size, rate, dt) { tryCatch( diff --git a/man/eulermultinom.Rd b/man/eulermultinom.Rd index 67bed0ec..47b12951 100644 --- a/man/eulermultinom.Rd +++ b/man/eulermultinom.Rd @@ -42,6 +42,11 @@ This contains the probabilities of observing each column of \code{x} given the s \code{eeulermultinom} returns a \code{length(rate)}-vector containing the expected number of individuals to have succumbed to the corresponding process. +With the notation above, if +\preformatted{ + dn <- eeulermultinom(size=N,rate=r,dt=dt), +} +then the \eqn{k}-th element of the vector \code{dn} will be \eqn{p_k N}{pk N}. \code{rgammawn} returns a vector of length \code{n} containing random increments of the integrated Gamma white noise process with intensity \code{sigma}. }