summary.bayesPop.prediction: Summary of Probabilistic Population Projection

Description Usage Arguments Author(s) See Also Examples

View source: R/get_outputs.R

Description

Summary of an object bayesPop.prediction created using the pop.predict function. The summary contains the mean, standard deviation and several commonly used quantiles of the simulated trajectories.

Usage

1
2
3
## S3 method for class 'bayesPop.prediction'
summary(object, country = NULL, 
    sex = c("both", "male", "female"), compact = TRUE, ...)

Arguments

object

Object of class bayesPop.prediction.

country

Country name or code. It can also be given as ISO-2 or ISO-3 characters. If it is NULL, only meta information included.

sex

One of “both” (default), “male”, or “female”. If it is not “both”, the summary is given for sex-specific trajectories.

compact

Logical switching between a smaller and larger number of displayed quantiles.

...

A list of further arguments.

Author(s)

Hana Sevcikova

See Also

bayesPop.prediction

Examples

1
2
3
sim.dir <- file.path(find.package("bayesPop"), "ex-data", "Pop")
pred <- get.pop.prediction(sim.dir)
summary(pred, "Netherlands")

bayesPop documentation built on Nov. 29, 2021, 5:07 p.m.