popstudy (version 1.0.0)

Lexis: Lexis diagram

Description

Plot a Lexis Diagram from births and deaths data for a given year, month, and day with specific simple ages.

Usage

Lexis(
  deaths_data,
  births_data,
  first.date = NULL,
  choose_year,
  choose_month,
  choose_day,
  ages,
  factors = NULL
)

Arguments

deaths_data

data.frame. A dataset with three variables: date_reg, the registered death date, age, the age of decease; and deaths, the deaths number for that date. See CR_deaths.

births_data

data data.frame. A dataset with two variables: date_reg, the registered birth date; and births, the births number for that date. See CR_births.

first.date

character. Optional argument that specifies the first date of interest.

choose_year

numeric. The year from which the countdown begins until the desired minimum age is reached.

choose_month

numeric. The month from which the countdown begins until the desired minimum age is reached.

choose_day

numeric. The day from which the countdown begins until the desired minimum age is reached.

ages

numeric. An ages vector to plot the diagram.

factors

numeric. Optional argument to set specific factors to set alpha and delta sections in Lexis Diagram.

Value

Lexis function returns a list with two objects: diagram, the Lexis diagram; and deaths, the estimated deaths number.

References

Lexispopstudy

Examples

# NOT RUN {
Lexis(CR_deaths, CR_births, choose_year=2011, choose_month=1, choose_day=1, ages=0:9)$diagram

##Lexis diagram with specific factors
data("births_deaths")
Births <- dplyr::filter(births_deaths$births, sex=="male")
Deaths <- dplyr::filter(births_deaths$deaths, sex=="male")
Lexis(deaths_data=Deaths, births_data=Births, first.date = "1999-01-01",
choose_year=2007, choose_month=1, choose_day=1, ages=0:4,
factors = c(.2,.41,.47,.48,.48))$diagram

# }