| NEWS | R Documentation |
News for R Package fastbeta
Changes in version 0.5.0 (2025-10-15)
Significant User-Visible Changes
-
sir.aoi(..., root = function)is a multiple time series object storing the solution until the last root or time point. Attributeroot.infostores details about the system at the roots in the formatlist(tau, state). Previously,sir.aoidiscarded the solution and returned only details about the system at the first root. -
sir.aoi(..., root = function)no longer has an attributecurvaturestoring the curvature ofYat the root.
Bug Fixes
The expression for
\text{d}Y/\text{d}\tauused bysir.aoiwas wrong.
New Features
-
sir.aoi(..., aggregate = TRUE)has additional columns storing the force of infection, incidence, and the curvature ofY. -
sir.aoiaccepts new argumentepsin order to support equations with equal, nonzero rates of birth and death. -
sir.aoiaccepts new argumentsFandFargs, enabling the user to set a forcing function. -
sir.aoiaccepts new argumentsHandHargs, enabling the user to set a susceptible hetereogeneity function. -
sir.aoiaccepts new argumentsroot.maxandroot.break, enabling the user to set the number of roots sought and indicate whether the solver should stop once that number of roots is reached. The default behaviour is to stop once one root is found and agrees with the previous behaviour. -
sir.aoiaccepts new argumentskip.Yindicating if solution of the equation forYshould not be attempted. The method for generic function
summaryand classsir.aoiaccepts new argumentname, enabling approximation of tail exponents of different variables.Function
cbind.tsfor working around PR#18583.-
deconvolveaccepts new argumentx.pad, enabling the user to decide the value of the elements with whichxis padded whenstartis unset. New data set
pneumonia, used in an example ofdeconvolveusage.
Changes in version 0.4.0 (2025-04-28)
Deprecated and Defunct
-
seir.canonicalis removed in favour of more generalsir.aoi. The method for generic functionsummaryand classseir.canonicalis removed in favour of a method for classsir.aoi.
New Features
Function
sir.aoigeneralizingseir.canonicalin order to support rates of transmission and recovery structured by age of infection.
Changes in version 0.3.2 (2025-03-23)
New Features
Function
seir.canonicalproviding a nondimensional interface to a special case (constant transmission, without vital dynamics, without loss of immunity) ofseirusage. The nondimensional parameters are the basic reproduction number and the ratio of the mean latent period and mean generation interval.A method for generic function
summaryand classseir.canonicalapproximating the tail exponents of prevalence.
Changes in version 0.3.1 (2024-11-22)
Significant User-Visible Changes
Formal argument
initoffastbeta,fastbeta.bootstrap,ptpi, andseiris repositioned.Formal arguments
sigmaandmoffastbeta,fastbeta.bootstrap,ptpi, andseirhave constant default values (sigma = 1,m = 1L) not depending on the values of other arguments.
Bug Fixes
Entry
[2, 2]of the Jacobian matrix constructed byseir(stochastic = FALSE, useCompiled = FALSE)was wrong.-
seirhandles more comprehensively the situation in which the number of rows of the matrix returned by deSolve functionlsodais less thanlength.out. It now distinguishes termination due to found roots from termination due to an unsuccessful solver call. Warnings caught by -Wconversion are squashed.
New Features
-
seirgains logical argumentaggregateindicating whether latent and infectious compartments should be aggregated. -
seirargumentsnuandmugain default values. In both cases, it isfunction (t) 0, indicating no vital dynamics. -
seir.R0,seir.ee, andseir.jacobianfor calculating the basic reproduction number, endemic equilibrium, and Jacobian matrix. -
fastbeta.matrixfor calculating lower triangular coefficient matrix.
Installation
Compilation now uses -DSTRICT_R_HEADERS and -DR_NO_REMAP.
Changes in version 0.3.0 (2024-05-17)
Significant User-Visible Changes
Argument
constantsof functionssir,fastbeta,fastbeta.bootstrap, andptpiis replaced by argumentssigma,gamma,delta,init,m, andn.-
siris now a wrapper calling newseir. Arguments
aandbof functionptpiare replaced by argumentsstartandendso that the interface is more similar to that ofwindow.-
ptpireturnslist(value, diff, iter, x), no longerlist(value, delta, iter, X). Simulations
sir.e01andsir.e02are replaced byseir.ts01andseir.ts02. The replacements have a latent compartment and a different set of attributes reflecting the API ofseir.
Bug Fixes
More simulations set
tl.params = list(epsilon = .)to mitigate noise attributable to too big leaps in the adaptive tau-leaping algorithm.-
plotmethod for classfastbeta.bootstrapusesdev.holdanddev.flushfrom grDevices to avoid “incremental” graphical output on some devices.
New Features
Compartmental model is generalized to support multiple infected compartments,
mlatent andninfectious, resulting in several backwards incompatible changes to the API; see below.
Installation
-
adaptivetau and deSolve are now suggested, not imported, as they are needed only for simulation. Usage of simulated data sets is now everywhere conditional on successful loading of the dependency.
Changes in version 0.2.0 (2023-12-11)
Significant User-Visible Changes
-
sirexpectsconstants = c(S0, I0, R0, gamma, delta), no longerconstants = c(gamma, S0, I0, R0). -
fastbetaandfastbeta.bootstrapexpectconstants = c(S0, I0, R0, gamma, delta), no longerconstants = c(gamma, S0, I0). -
ptpigains argumentconstantsand loses argumentstart. It expectsconstants = c(Sa, Ia, Ra, gamma, delta), no longerstart = Sa. -
fastbetareturns (modulo attributes)cbind(S, I, R, beta), no longercbind(beta, S, I). -
ptpi(...)[[1L]]gives the state at time0or at timeaconditional on new argumentbackcalc. The default isa, no longer (implicitly)0. -
ptpi(...)[[4L]]has dimensionsc(b-a+1, 3, iter), no longerc(b-a+1, iter). Simulation
sir.e01is generated by the same parameters but is no longer stochastic. Simulationsir.e02gives the stochastic variant.
New Features
Compartmental model is generalized to support loss of immunity at rate
delta, resulting in several backwards incompatible changes to the API; see below.
Installation
-
‘data/*.R’ are no longer copied to ‘inst/scripts’ at install time by a
makerule in ‘src/Makevars’. There is no need: the scripts are preserved due to the setting ofBuildResaveData: no. Hence ‘src/Makevars’ is removed.
Changes in version 0.1.1 (2023-11-28)
Bug Fixes
Typo in ‘src/sir.c’ triggering -Wformat is fixed.
New Features
Changes are logged in ‘inst/NEWS.Rd’.
-
‘DESCRIPTION’ sets
BuildResaveData: no, so thatR CMD buildworks without --no-resave-data when fastbeta is not installed.
Installation
-
‘data/*.R’ are copied into ‘inst/scripts’ at install time by a
makerule in ‘src/Makevars’. -
Depends: R (>= 4.3.0)foramsmathin PDF output, which was not supported until 4.2.2.