pdf_report: Output a report to PDF

In wjunger/ares: Environmental air pollution epidemiology: a library for time series analysis

Description

Output the analysis results and diagnostics to a PDF file

Usage

pdf_report(model, file, pollutants, method = "pdlm", labels = toupper(pollutants),
	unit=10, outcome.label = NULL, city = NULL, df = 0, ...)

Arguments

model	a model fitted by fit_core
file	a string with a file name to save the output, i.e., "output.pdf"
pollutants	a vector with the names of the variables to estimate the effects
method	estimation method to be used to estimate the pollutant effect. Default is pdlm for distributed lag models. Use both for both single lag and PDLM estimates
labels	a vector of quoted strings with alternate labels for the pollutants. Default is the names of the variables in pollutant
unit	a vector indicating the units for relative risk computation. Default is 10 for all pollutants. See Details
outcome.label	an alternate label for the outcome variable
city	a string indicating the city. It is for the header
df	the number of degrees of freedom for the outcome variable smoothing. Default is 0 for no smoothing
...	further options for estimate_risks

Details

This function outputs several diagnostics plots and statistics of the core model. It also outputs the effects estimates. The results are piped to a PDF device. See pdf for details.

Value

This function does not return a value.

Author(s)

Washington Junger [e-mail] and Antonio Ponce de Leon [e-mail]

References

Schwartz, J., Spix, C., Touloumi, G. et al. (1996) Methodological issues in studies of air pollution and daily counts of deaths or hospital admissions. J Epidemiol. Community Health 50 (suppl 1), S12–S18.

Schwartz, J. (2000) The distributed lag between air pollution and daily deaths. Epidemiology 11(3), 320–326.

McGullagh, P., Nelder, J. A. (1989) Generalized linear models. Chapman and Hall.

Hastie, T., Tibshirani, R. (1990) Generalized additive models. 2 ed. Chapman and Hall.

See Also

fit_core,print_risk,plot_risk

Examples

data(admrio)
setup(admrio,"date")
f <- resp5~s(time)+weekdays+s(tmpmax)+s(humid)
m <- fit_core(f)

## pdlm effect estimation
pdf_report(m,"test.pdf",pollutants=c("so2","pm10"),labels=c("SO2","PM10"),unit=10)

wjunger/ares documentation built on Dec. 23, 2021, 5:17 p.m.