summary.bayesMig.prediction {bayesMig}

Summary of Prediction of Net Migration Rate

Description

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

Usage

## S3 method for class 'bayesMig.prediction'
summary(object, country = NULL, compact = TRUE, ...)

## S3 method for class 'summary.bayesMig.prediction'
print(x, digits = 3, ...)

Arguments

object

Object of class bayesMig.prediction.

country

Location name or code if a location-specific summary is desired. The code can be either numeric or (if locations are countries) ISO-2 or ISO-3 characters. If it is NULL, only prediction meta info is included.

compact

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

...

A list of further arguments.

x

A result of the summary function.

digits

Minimal number of significant digits.

Value

summary returns a list with objects burnin, nr.traj, projection.years, country.name containing the MCMC burn-in, number of trajectories, projected years and name of the location, respectively. The projection results are stored in the item projections which is a matrix with rows being the years and columns being the mean and various quantiles.

Examples

# See example in ?mig.predict