predict.ugrpl: Predict Method for Unit Gamma Regression with Parametric Link...

View source: R/6_methods.R

predict.ugrplR Documentation

Predict Method for Unit Gamma Regression with Parametric Link Functions

Description

Obtains predictions from a fitted unit gamma regression object.

Usage

## S3 method for class 'ugrpl'
predict(
  object,
  newdata = NULL,
  type = c("response", "link", "dispersion", "variance", "quantile"),
  na.action = stats::na.pass,
  at = 0.5,
  ...
)

Arguments

object

a 'ugrpl' object.

newdata

optionally, a data frame in which to look for variables with which to predict. If omitted, the fitted linear predictors are used.

type

the type of prediction required. The default is on the scale of the response variable ("response"), that is, the fitted values (fitted means). The alternative "link" is on the scale of the linear predictors. The specification "dispersion" provides the fitted dispersion parameters, while "variance" provides the fitted variances. Finally, the option "quantile" gives the fitted quantiles in the order specified via 'at'.

na.action

function determining what should be done with missing values in newdata. The default is to predict NA.

at

the order of the quantile to be predicted if type = "quantile". The default is to predict the median, that is, at = 0.5.

...

arguments passed to or from other methods.

Value

A vector of predictions.


rdmatheus/ugrpl documentation built on July 13, 2024, 10:24 p.m.