Learn R Programming

DALY (version 1.2.0)

summary.DALY: Summary method for class 'DALY'

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, \dots)

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

Value

  • summary.DALY returns a list containg the following elements:
  • totalMatrix containing mean, median and prob credible interval of total DALYs, YLDs, YLLs, cases and deaths
  • outcomesNamed list, containing matrices of DALYs, YLDs, YLLs, cases and deaths for each health outcome
  • pctVector of contribution of YLDs and YLLs to overall DALYs

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.

See Also

print.DALY, aggregate.DALY DALYcalculator (for a brief description of the DALY Calculator) DALYmanual (for a more comprehensive overview)

Examples

Run this code
##= 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 ===============

Run the code above in your browser using DataLab