summary.DALY: Summary method for class 'DALY'

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

Description

Print summary of DALY Calculator output per age/sex class.

Usage

## S3 method for class 'DALY'
summary(object, relative = FALSE, outcomes = FALSE,
        digits = 0, ...)

Arguments

object	Object of class 'DALY'
relative	Show results per 1000 population? See details below
outcomes	Show results per outcome? See details below
digits	Number of decimals to be printed; defaults to 0
...	Additional arguments to be passed to summary

Details

The standard summary method gives the absolute number of DALYs, YLDs, YLLs, cases and deaths. By specifying relative = TRUE, the number of DALYs, YLDs, YLLs, cases and deaths per 1,000 population will be shown.

The standard summary method gives the number of DALYs, YLDs, YLLs, cases and deaths aggregated over all health outcomes. By specifying outcomes = TRUE, the number of DALYs, YLDs, YLLs, cases and deaths for each outcome will be shown as well.

Value

summary.DALY returns a list containg the following elements:

total	Matrix containing mean, median and prob credible interval of total DALYs, YLDs, YLLs, cases and deaths
outcomes	Named list, containing matrices of DALYs, YLDs, YLLs, cases and deaths for each health outcome
pct	Vector of contribution of YLDs and YLLs to overall DALYs

Author(s)

[e-mail]

See Also

print.DALY, aggregate.DALY

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, store results in 'x' ========
x <- getDALY()

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

## End(Not run)

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