DALY (version 1.1.0)

getDALY: Initiate the DALY calculation process

Description

This function initiates the Monte Carlo DALY calculation process, based on the entered data, and returns the simulated results.

Usage

getDALY(button.call = FALSE)

Arguments

button.call

Gives information on the origin of the call (i.e., through the GUI button (TRUE) or the RConsole (FALSE))

Value

• getDALY returns an object of class 'DALY', which inherits from class 'list'. The generic functions print and summary may be used to obtain and print the DALY calculation results. The generic function aggregate extracts from the 'DALY' object results by outcome, age/sex class, or both. An object of class 'DALY' is a list containing the following elements:
• i
  For each outcome i, an unnamed list containing simulated results (see next paragraph)
• pop
  Population
• name
  Name of the disease
• For each outcome i, DALY[[i]] is a list containing the following elements:
• DALY
  Vector of simulated DALYs
• YLD
  Vector of simulated YLDs
• YLL
  Vector of simulated YLLs
• INC
  Vector of simulated incident cases
• MRT
  Vector of simulated deaths
• name
  Name of the health outcome
• The vectors containing simulated DALYs, YLDs, YLLs, incident cases and deaths each have three dimensions:
• 1
  Iterations
• 2
  Age groups
• 3
  Sex

See Also

The numerical output methods for 'DALY': print.DALY, summary.DALY The graphical output method for 'DALY': hist.DALY The aggregator method for 'DALY': aggregate.DALY DALYcalculator (for a brief description of the DALY Calculator) DALYmanual (for a more comprehensive overview)

Examples

## load the Neurocysticercosis example
setDALYexample(1)

## initiate the Monte Carlo simulation process, and store results in object x
x <- getDALY()

## view the structure of 'x'
str(x)

## view the DALY calculation results
print(x)                   # absolute, total
print(x, relative = TRUE)  # relative (ie, per 1000 population)
print(x, outcomes = TRUE)  # outcome-wise

## obtain minimum & maximum simulated DALY
min(x[[1]]$DALY)
max(x[[1]]$DALY)