Skip to contents

Get starting time period, ending time period and mortality cause name from the data set for use in axis and main plot titles.

Usage

iidda_get_metadata(data, time_variable = NULL, descriptor_variable = NULL)

Arguments

data

data frame containing time series data

time_variable

column name of time variable in data, default is "period_end_date"

descriptor_variable

column name of the descriptor variable in data, default is "cause" for mortality data sets.

Value

a list in order containing minimum time period, maximum time period and cause name.