ReadHMD: Download Mortality and Population Data (HMD)

Description Usage Arguments Value Author(s) Examples

View source: R/readHMD.R

Description

Download detailed mortality and population data for different countries and regions in a single object from the Human Mortality Database.

Usage

1
2
ReadHMD(what, countries = NULL, interval = "1x1", username, password,
  save = FALSE, show = TRUE)

Arguments

what

What type of data are you looking for? The following options are available:

  • "births" – birth records;

  • "Dx_lexis" – deaths by Lexis triangles;

  • "Ex_lexis" – exposure-to-risk by Lexis triangles;

  • "population" – population size;

  • "Dx" – death counts;

  • "Ex" – exposure-to-risk;

  • "mx" – central death-rates;

  • "LT_f" – period life tables for females;

  • "LT_m" – period life tables for males;

  • "LT_t" – period life tables both sexes combined;

  • "e0" – period life expectancy at birth;

  • "Exc" – cohort exposures;

  • "mxc" – cohort death-rates;

  • "LT_fc" – cohort life tables for females;

  • "LT_mc" – cohort life tables for males;

  • "LT_tc" – cohort life tables both sexes combined;

  • "e0c" – cohort life expectancy at birth;

countries

Specify the country data you want to download by adding the HMD country code/s. Options: "AUS","AUT","BEL","BGR","BLR","CAN","CHL","CHE","CZE", "DEUTE", "DEUTNP","DEUTW","DNK","ESP","EST","FIN","FRACNP","FRATNP","KOR","GBR_NIR", "GBR_NP","GBR_SCO","GBRCENW","GBRTENW","GRC","HUN","HRV","IRL","ISL","ISR", "ITA","JPN","LTU","LUX","LVA","NLD","NOR","NZL_MA","NZL_NM","NZL_NP","POL", "PRT","RUS","SVK","SVN","SWE","TWN","USA","UKR".

interval

HMD data format: (age interval x year interval). Interval options: 1x1, 1x5, 1x10, 5x1, 5x5, 5x10.

username

Your HMD username. If you don't have one you can sign up for free on the Human Mortality Database website.

password

Your HMD password.

save

Do you want to save a copy of the dataset on your local machine? Logical. Default: FALSE.

show

Choose whether to display a progress bar. Logical. Default: TRUE.

Value

A ReadHMD object that contains:

input

List with the input values (except the password).

data

Data downloaded from HMD.

download.date

Time stamp.

years

Numerical vector with the years covered in the data.

ages

Numerical vector with ages covered in the data.

Author(s)

Marius D. Pascariu

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
## Not run: 
# Download demographic data for 3 countries in 1x1 format 
age_int  <- 1  # age interval: 1,5
year_int <- 1  # year interval: 1,5,10
interval <- paste0(age_int, "x", year_int)  # --> 1x1
# And the 3 countries: Sweden Denmark and USA. We have to use the HMD codes
cntr  <- c('SWE', 'DNK', 'USA')  

# Download death counts. We don't want to export data outside R.
HMD_Dx <- ReadHMD(what = "Dx",
                  countries = cntr,
                  interval  = interval,
                  username  = "[email protected]",
                  password  = "password",
                  save = FALSE)
ls(HMD_Dx)
HMD_Dx

# Download life tables for female population and export data.
LTF <- ReadHMD(what = "LT_f",
               countries = cntr,
               interval  = interval,
               username  = "[email protected]",
               password  = "password",
               save = TRUE)
LTF

## End(Not run) 

MortalityLaws documentation built on Nov. 6, 2018, 5:04 p.m.