Generate a popim_population object from a dataframe

Checks if the dataframe is suitable (i.e., contains appropriate columns and data ranges), and if so converts it to a popim_population object and returns this.

as_popim_pop(df)

Arguments

df

a dataframe with at least columns region, age, year and pop_size.

Value

an object of class popim_population

Details

The input dataframe has to have at least the columns region, age, and year. The output popim_population object is generated via expand.grid to have consecutive year and age ranges that are identical for all regions.

If the input dataframe contains a column pop_size, this must be numeric and non-negative. If it is missing, this column is generated and initialised to NA.

If the input dataframe contains a colum immunity, this must be numeric, with values between 0 and 1. If it is missing, this column is generated and initialised to 0.

Any further colunms are simply carried over into the popim_population object.

Author

Tini Garske

Examples

## set up a minimal dataframe to convert to a popim_population object:
df <- expand.grid(region = "UK", age = 0:3, year = 2000:2004, stringsAsFactors = FALSE)
pop <- as_popim_pop(df)