capm (version 0.9.1)

CalculatePopChange: Population change.

Description

Calculate the change in population size between two times. When only one time is specified, the population size at that time is returned.

Usage

CalculatePopChange(model.out = NULL, variable = NULL, t1 = NULL, t2 = NULL, ratio = TRUE)

Arguments

model.out

an output from one of the following functions or a list with equivalent structure: SolveIASA, SolveSI or SolveTC.

variable

string with the name of the the output variable for which the change needs to be calculated (see the variable argument for PlotModels.

t1

value specifying the first time.

t2

value specifying the second time.

ratio

logical. When TRUE, the calculated change is based on poulation size at t2 divided by population size at t1. When FALSE, the calculated change is based on poulation size at t2 minus population size at t1.

Value

Value representing the ratio (if ratio is TRUE) or the difference (if ratio is FALSE) between population size at time t2 and t1. If only one time is specified, the value is the population size at that time.

References

http://oswaldosantos.github.io/capm

Examples

###################
## SolveSI model ##
###################

# Parameters and initial conditions.
pars.solve.si = c(b = 0.245, d = 0.101, 
                 k = 98050, s = 0.048)
init.solve.si = c(n = 89137, q = 0.198)

# Solve for a specific sterilization rate.
solve.si.pt = SolveSI(pars = pars.solve.si, 
                             init = init.solve.si, 
                             time = 0:15, dd = 'b',
                             im = 100, method = 'rk4')

# Calculate the population change (ratio) between times 0 and 15.
CalculatePopChange(solve.si.pt, variable = 'n', t2 = 15, t1 = 0)

# Calculate the population change (difference) between times 0 and 15.
CalculatePopChange(solve.si.pt, variable = 'n', t2 = 15,
                   t1 = 0, ratio = FALSE)

# Calculate the population zises at time 15.
CalculatePopChange(solve.si.pt, variable = 'n', t2 = 15)