getDALY: Initiate the DALY calculation process

In DALY: The DALY Calculator - Graphical User Interface for Probabilistic DALY Calculation in R

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, aw, dr)

Arguments

button.call	Gives information on the origin of the call (i.e., through the GUI button (TRUE) or the R Console (FALSE))
aw	Logical flag, indicating if age weighting should be applied; if aw is not specified, the value from the GUI will be used
dr	Time discount rate (numeric value between 0 and 1); if dr is not specified, the value from the GUI will be used

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

Author(s)

[e-mail]

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
DALY sensitivity analysis : sensitivity

DALYcalculator (for a brief description of the DALY Calculator)
DALYmanual (for a more comprehensive overview)

Examples

## Not run: 

##= load the NCC example ==================================
setDALYexample(1)

##= perform DALY calculation  =============================
##= without age weighting and time discounting ============
getDALY(aw = FALSE, dr = 0)

##= perform DALY calculation, store results in 'x' ========
##= (with age weighting and a 3% time discount rate) ======
x <- getDALY(aw = TRUE, dr = 0.03)

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

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

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

##= standardized DALY histogram ===========================
hist(x)

##= DALY sensitivity analysis =============================
sensitivity(x)

## End(Not run)

DALY documentation built on May 2, 2019, 12:19 p.m.