regressionEmailReport: Email a Regression Evaluation Report

Description Usage Arguments Value See Also Examples

View source: R/regressionEvaluation.R

Description

Given the result of regressionEvaluation email a standardised report to one or more recipients.

The emailed report contains a residual vs fitted plot, a residual vs order plot, a histogram of actual, predictions and residuals' distributions, a prediction intervals plot, and a plot of cumulative If the model is provided, some basic descriptions about the model will also be reported. If the model provided is a glm, glm.check.assumptions function will be used to check the assumptions of the model(e.g. linearity).

Usage

1
2
regressionEmailReport(evaluationResults, toAddress = "your.name@gmail.com",
  additionalMessage = "", plotSize = 10)

Arguments

evaluationResults

The result from running regressionEvaluation.

toAddress

Character vector, containing the email address(es) to send the report to, when completed.

additionalMessage

A string that will appear in the subject of the email

plotSize

Numeric scalar containing the side length of the resulting square png files, in pixels.

Value

The result of the call to sendmail

See Also

RQuantSendMail, regressionEvaluation

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
set.seed(123)
data(mtcars)
fit <- glm(mpg ~ cyl + disp + hp + drat, data=as.data.frame(mtcars), family = gaussian())
actuals <- mtcars$mpg
probs <- predict(fit, mtcars)
res <- regressionEvaluation(pred = probs,
obs = actuals,
model = fit,
sample_size=1e5,
seed = 1234)

regressionEmailReport(res,"ivan@xxx.com")

ivanliu1989/RQuant documentation built on Sept. 13, 2019, 11:53 a.m.