Learn R Programming

⚠️There's a newer version (1.1-13) of this package.Take me there.

VGAM (version 1.0-0)

Vector Generalized Linear and Additive Models

Description

An implementation of about 6 major classes of statistical regression models. At the heart of it are the vector generalized linear and additive model (VGLM/VGAM) classes, and the book "Vector Generalized Linear and Additive Models: With an Implementation in R" (Yee, 2015) gives details of the statistical framework and VGAM package. Currently only fixed-effects models are implemented, i.e., no random-effects models. Many (150+) models and distributions are estimated by maximum likelihood estimation (MLE) or penalized MLE, using Fisher scoring. VGLMs can be loosely thought of as multivariate GLMs. VGAMs are data-driven VGLMs (i.e., with smoothing). The other classes are RR-VGLMs (reduced-rank VGLMs), quadratic RR-VGLMs, reduced-rank VGAMs, RCIMs (row-column interaction models)---these classes perform constrained and unconstrained quadratic ordination (CQO/UQO) models in ecology, as well as constrained additive ordination (CAO). Note that these functions are subject to change; see the NEWS and ChangeLog files for latest changes.

Copy Link

Version

Install

install.packages('VGAM')

Monthly Downloads

42,195

Version

1.0-0

License

GPL-2 | GPL-3

Maintainer

Thomas Yee

Last Published

October 29th, 2015

Functions in VGAM (1.0-0)

gamma2

2-parameter Gamma Distribution
Card

Cardioid Distribution
grc

Row-Column Interaction Models including Goodman's RC Association Model and Unconstrained Quadratic Ordination
Lino

The Generalized Beta Distribution (Libby and Novick, 1982)
cratio

Ordinal Regression with Continuation Ratios
dirmul.old

Fitting a Dirichlet-Multinomial Distribution
golf

Gamma-Ordinal Link Function
logistic

Logistic Distribution Family Function
hzeta

Haight's Zeta Family Function
Binorm

Bivariate normal distribution cumulative distribution function
expexpff1

Exponentiated Exponential Distribution
olympics

2008 and 2012 Summer Olympic Final Medal Count Data
explogff

Exponential Logarithmic Distribution Family Function
PoissonPoints

Poisson Points Distribution
double.expbinomial

Double Exponential Binomial Distribution Family Function
chinese.nz

Chinese Population in New Zealand 1867--2001 Data
frechet

Frechet Distribution Family Function
brat

Bradley Terry Model
skewnorm

Skew-Normal Distribution
loglinb2

Loglinear Model for Two Binary Responses
exppoisson

Exponential Poisson Distribution Family Function
kumar

Kumaraswamy Distribution Family Function
gevUC

The Generalized Extreme Value Distribution
Gumbel-II

The Gumbel-II Distribution
cauchy

Cauchy Distribution Family Function
Expectiles-Exponential

Expectiles of the Exponential Distribution
cfibrosis

Cystic Fibrosis Data
bratt

Bradley Terry Model With Ties
explog

The Exponential Logarithmic Distribution
concoef-methods

Constrained (Canonical) Coefficients
zabinomial

Zero-Altered Binomial Distribution
cauchit

Cauchit Link Function
expgeom

The Exponential Geometric Distribution
coalminers

Breathlessness and Wheeze Amongst Coalminers Data
seq2binomial

The Two-stage Sequential Binomial Distribution Family Function
bisa

Birnbaum-Saunders Distribution Family Function
exponential

Exponential Distribution
flourbeetle

Mortality of Flour Beetles from Carbon Disulphide
calibrate-methods

Calibration for Constrained Regression Models
erf

Error Function, and variants
loglapUC

The Log-Laplace Distribution
hspider

Hunting Spider Data
leukemia

Acute Myelogenous Leukemia Survival Data
Truncpareto

The Truncated Pareto Distribution
deermice

Captures of Peromyscus maniculatus, also known as deer mice.
binormal

Bivariate normal distribution family function
cens.normal

Censored Normal Distribution
melbmaxtemp

melbmaxtemp daily maximum temperatures
bmi.nz

Body Mass Index of New Zealand Adults Data
iam

Index from Array to Matrix
crashes

Crashes on New Zealand Roads in 2009
logit

Logit Link Function
ducklings

Relative Frequencies of Serum Proteins in white Pekin ducklings
confintvglm

Confidence Intervals for VGLM Parameters
gev

Generalized Extreme Value Distribution Family Function
gammaR

2-parameter Gamma Distribution
is.smart

Test For a Smart Object
cao.control

Control Function for RR-VGAMs (CAO)
double.cens.normal

Univariate Normal Distribution with Double Censoring
inv.lomax

Inverse Lomax Distribution Family Function
mix2normal

Mixture of Two Univariate Normal Distributions
biplackettcop

Plackett's Bivariate Copula Family Function
corbet

Corbet's Butterfly Data
erlang

Erlang Distribution
gaussianff

Gaussian (normal) Family Function
biplot-methods

Biplot of Constrained Regression Models
lms.bcg

LMS Quantile Regression with a Box-Cox transformation to a Gamma Distribution
oxtemp

Oxford Temperature Data
uninormal

Univariate Normal Distribution
posbernoulli.b

Positive Bernoulli Family Function with Behavioural Effects
lirat

Low-iron Rat Teratology Data
Expectiles-Normal

Expectiles of the Normal Distribution
gamma1

1-parameter Gamma Distribution
gumbelUC

The Gumbel Distribution
paretoIV

Pareto(IV/III/II) Distribution Family Functions
formulavlm

Model Formulae and Term Names for VGLMs
Foldnorm

The Folded-Normal Distribution
gpd

Generalized Pareto Distribution Family Function
get.smart.prediction

Retrieves ``.smart.prediction''
loge

Log link function, and variants
genray

The Generalized Rayleigh Distribution
cens.gumbel

Censored Gumbel Distribution
Expectiles-Uniform

Expectiles of the Uniform Distribution
Felix

The Felix Distribution
fill

Creates a Matrix of Appropriate Dimension
dgenpois

The Generalized Poisson Distribution
depvar

Response variable extracted
Fisk

The Fisk Distribution
inv.gaussianff

Inverse Gaussian Distribution Family Function
smart.mode.is

Determine What Mode the Smart Prediction is In
Posnegbin

Positive-Negative Binomial Distribution
is.parallel

Parallelism Constraint Matrices
laplaceUC

The Laplace Distribution
plotrcim0

Main effects plot for a Row-Column Interaction Model (RCIM)
Log

Logarithmic Distribution
Zibinom

Zero-Inflated Binomial Distribution
fisherz

Fisher's Z Link Function
deplot.lmscreg

Density Plot for LMS Quantile Regression
finney44

Toxicity trial for insects
calibrate

Model Calibrations
linkfun.vglm

Link Functions for VGLMs
Dagum

The Dagum Distribution
dhuber

Huber's least favourable distribution
fff

F Distribution Family Function
lgamma1

Log-gamma Distribution Family Function
df.residual

Residual Degrees-of-Freedom
foldsqrt

Folded Square Root Link Function
Bort

The Borel-Tanner Distribution
borel.tanner

Borel-Tanner Distribution Family Function
marital.nz

New Zealand Marital Data.
garma

GARMA (Generalized Autoregressive Moving-Average) Models
multilogit

Multi-logit Link Function
gumbel

Gumbel Distribution Family Function
cdf.lmscreg

Cumulative Distribution Function for LMS Quantile Regression
mccullagh89

McCullagh (1989) Distribution Family Function
Perks

The Perks Distribution
notdocumentedyet

Undocumented and Internally Used Functions and Classes
Binormcop

Gaussian Copula (Bivariate) Distribution
expexpff

Exponentiated Exponential Distribution
grain.us

Grain Prices Data in USA
gew

General Electric and Westinghouse Data
prplot

Probability Plots for Categorical Data Analysis
Paralogistic

The Paralogistic Distribution
Pospois

Positive-Poisson Distribution
chest.nz

Chest Pain in NZ Adults Data
clo

Redirects the user to rrvglm
nakagami

Nakagami Distribution Family Function
exppois

The Exponential Poisson Distribution
expint

The Exponential Integral and Variants
rigff

Reciprocal Inverse Gaussian distribution
hypersecant

Hyperbolic Secant Distribution Family Function
huber2

Huber's least favourable distribution family function
hormone

Hormone Assay Data
prinia

Yellow-bellied Prinia
identitylink

Identity Link Function
rayleigh

Rayleigh Distribution Family Function
GenbetaII

The Generalized Beta II Distribution
freund61

Freund's (1961) Bivariate Extension of the Exponential Distribution
rec.exp1

Upper Record Values from a 1-parameter Exponential Distribution
perspqrrvglm

Perspective plot for QRR-VGLMs
has.interceptvlm

Has a Fitted VGLM Got an Intercept Term?
paretoff

Pareto and Truncated Pareto Distribution Family Functions
machinists

Machinists Accidents
Zipf

The Zipf Distribution
multinomial

Multinomial Logit Model
micmen

Michaelis-Menten Model
lrtest

Likelihood Ratio Test of Nested Models
margeff

Marginal effects for the multinomial logit and cumulative models
lambertW

The Lambert W function
posbernoulli.tb

Positive Bernoulli Family Function with Time and Behavioural Effects
pgamma.deriv.unscaled

Derivatives of the Incomplete Gamma Integral (Unscaled Version)
Gompertz

The Gompertz Distribution
skellam

Skellam Distribution Family Function
nbolf

Negative Binomial-Ordinal Link Function
binormalcop

Gaussian Copula (Bivariate) Family Function
inv.binomial

Inverse Binomial Distribution Family Function
Lomax

The Lomax Distribution
genrayleigh

Generalized Rayleigh Distribution Family Function
lms.yjn

LMS Quantile Regression with a Yeo-Johnson Transformation to Normality
rrvglm-class

Class ``rrvglm''
bistudentt

Bivariate Student-t Family Function
lindley

1-parameter Gamma Distribution
calibrate.qrrvglm.control

Control function for CQO/CAO calibration
lvplot

Latent Variable Plot
constraints

Constraint Matrices
inv.paralogistic

Inverse Paralogistic Distribution Family Function
riceff

Rice Distribution Family Function
logoff

Log link function with an offset
guplot

Gumbel Plot
lerch

Lerch Phi Function
zeta

Riemann's Zeta Function
Polono

The Poisson Lognormal Distribution
log1pexp

Logarithms with an Unit Offset and Exponential Term
concoef

Extract Model Constrained/Canonical Coefficients
genpoisson

Generalized Poisson distribution
rrvglm.control

Control function for rrvglm
Posnorm

The Positive-Normal Distribution
lgammaUC

The Log-Gamma Distribution
logc

Complementary-log Link Function
rhobit

Rhobit Link Function
Triangle

The Triangle Distribution
lqnorm

Minimizing the L-q norm Family Function
Posbinom

Positive-Binomial Distribution
fittedvlm

Fitted Values of a VLM object
model.matrixvlm

Construct the Design Matrix of a VLM Object
powerlink

Power Link Function
linkfun

Link functions
cqo

Fitting Constrained Quadratic Ordination (CQO)
posnormal

Positive Normal Distribution Family Function
calibrate.qrrvglm

Calibration for CQO and CAO models
ordpoisson

Ordinal Poisson Family Function
plotvgam

Default VGAM Plotting
mix2poisson

Mixture of Two Poisson Distributions
makeham

Makeham Distribution Family Function
sinmad

Singh-Maddala Distribution Family Function
explink

Exponential Link Function
dirichlet

Fitting a Dirichlet Distribution
latvar

Latent Variables
smartpred

Smart Prediction
probit

Probit Link Function
levy

Levy Distribution Family Function
zinegbinomial

Zero-Inflated Negative Binomial Distribution Family Function
Posgeom

Positive-geometric Distribution
cens.poisson

Censored Poisson Family Function
logff

Logarithmic Distribution
poisson.points

Poisson-points-on-a-plane/volume Distances Distribution
plotqtplot.lmscreg

Quantile Plot for LMS Quantile Regression
Yules

Yule-Simon Distribution
waitakere

Waitakere Ranges Data
Zapois

Zero-Altered Poisson Distribution
nparam.vlm

Number of Parameters
gengamma.stacy

Generalized Gamma distribution family function
leipnik

Leipnik Distribution Family Function
polf

Poisson-Ordinal Link Function
enzyme

Enzyme Data
dlogF

log F Distribution
quasipoissonff

Quasi-Poisson Family Function
foldnormal

Folded Normal Distribution Family Function
gengammaUC

The Generalized Gamma Distribution
chisq

Chi-squared Distribution
lvplot.qrrvglm

Latent Variable Plot for QO models
weibullR

Weibull Distribution Family Function
hatvalues

Hat Values and Regression Deletion Diagnostics
cloglog

Complementary Log-log Link Function
is.zero

Zero Constraint Matrices
toxop

Toxoplasmosis Data
rrar

Nested reduced-rank autoregressive models for multiple time series
vgam.control

Control function for vgam
yeo.johnson

Yeo-Johnson Transformation
Rice

The Rice Distribution
simplex

Simplex Distribution Family Function
geometric

Geometric (Truncated and Untruncated) Distributions
cumulative

Ordinal Regression with Cumulative Probabilities
predictqrrvglm

Predict Method for a CQO fit
logLik.vlm

Extract Log-likelihood for VGLMs/VGAMs/etc.
pgamma.deriv

Derivatives of the Incomplete Gamma Integral
cao

Fitting Constrained Additive Ordination (CAO)
cardioid

Cardioid Distribution Family Function
qrrvglm.control

Control function for QRR-VGLMs (CQO)
dirmultinomial

Fitting a Dirichlet-Multinomial Distribution
vglm

Fitting Vector Generalized Linear Models
gammahyperbola

Gamma Hyperbola Bivariate Distribution
lms.bcn

LMS Quantile Regression with a Box-Cox Transformation to Normality
zanegbinomial

Zero-Altered Negative Binomial Distribution
vgam-class

Class ``vgam''
gumbelII

Gumbel-II Distribution Family Function
plotvgam.control

Control Function for plotvgam()
poissonff

Poisson Family Function
Slash

Slash Distribution
expgeometric

Exponential Geometric Distribution Family Function
Coef

Computes Model Coefficients and Quantities
negbinomial

Negative Binomial Distribution Family Function
posbinomial

Positive Binomial Distribution Family Function
meplot

Mean Excess Plot
Inv.gaussian

The Inverse Gaussian Distribution
plotqrrvglm

Model Diagnostic Plots for QRR-VGLMs
qtplot.gumbel

Quantile Plot for Gumbel Regression
kendall.tau

Kendall's Tau Statistic
zageometric

Zero-Altered Geometric Distribution
trplot

Trajectory Plot
is.buggy

Does the fitted object suffer from a known bug?
venice

Venice Maximum Sea Levels Data
trplot.qrrvglm

Trajectory plot for QRR-VGLMs
vcovvlm

Calculate Variance-Covariance Matrix for a Fitted VLM or RR-VGLM Object
tikuv

Short-tailed Symmetric Distribution Family Function
put.smart

Adds a List to the End of the List ``.smart.prediction''
loglog

Log-log Link Function
lvplot.rrvglm

Latent Variable Plot for RR-VGLMs
wrapup.smart

Cleans Up After Smart Prediction
Binom2.or

Bivariate Binary Regression with an Odds Ratio
weibull.mean

Weibull Distribution Family Function, Parameterized by the Mean
Zanegbin

Zero-Altered Negative Binomial Distribution
lakeO

Annual catches on Lake Otamangakau from October 1974 to October 1989
propodds

Proportional Odds Model for Ordinal Regression
prentice74

Prentice (1974) Log-gamma Distribution
skewnormal

Univariate Skew-Normal Distribution Family Function
vsmooth.spline

Vector cubic smoothing spline
vglmff-class

Class ``vglmff''
setup.smart

Smart Prediction Setup
amlnormal

Asymmetric Least Squares Quantile Regression
Zageom

Zero-Altered Geometric Distribution
zipoisson

Zero-Inflated Poisson Distribution Family Function
tobit

Tobit Model
loglaplace

Log-Laplace and Logit-Laplace Distribution Family Functions
posbernUC

Positive Bernoulli Sequence Model
sc.studentt2

Scaled Student t Distribution with 2 df Family Function
nbcanlink

Negative binomial canonical link function
Zinegbin

Zero-Inflated Negative Binomial Distribution
plotdeplot.lmscreg

Density Plot for LMS Quantile Regression
qvar

Quasi-variances Extraction Function
rrvglm

Fitting Reduced-Rank Vector Generalized Linear Models (RR-VGLMs)
get.smart

Retrieve One Component of ``.smart.prediction''
wine

Bitterness in Wine Data
mix2exp

Mixture of Two Exponential Distributions
model.framevlm

Construct the Model Frame of a VLM Object
normal.vcm

Univariate Normal Distribution as a Varying-Coefficient Model
Zigeom

Zero-Inflated Geometric Distribution
pneumo

Pneumoconiosis in Coalminers Data
posbernoulli.t

Positive Bernoulli Family Function with Time Effects
negbinomial.size

Negative Binomial Distribution Family Function With Known Size
Maxwell

The Maxwell Distribution
ruge

Rutherford-Geiger Polonium Data
aux.posbernoulli.t

Auxiliary Function for the Positive Bernoulli Family Function with Time Effects
rrvglm.optim.control

Control function for rrvglm() calling optim()
yulesimon

Yule-Simon Family Function
lognormal

Lognormal Distribution
vonmises

von Mises Distribution Family Function
studentt

Student t Distribution
rec.normal

Upper Record Values from a Univariate Normal Distribution
reciprocal

Reciprocal link function
moffset

Matrix Offset
zetaff

Zeta Distribution Family Function
qtplot.lmscreg

Quantile Plot for LMS Quantile Regression
prats

Pregnant Rats Toxological Experiment Data
auuc

Auckland University Undergraduate Counts Data
laplace

Laplace Distribution
plotvglm

Plots for VGLMs
pospoisson

Positive Poisson Distribution Family Function
Expectiles-sc.t2

Expectiles/Quantiles of the Scaled Student t Distribution with 2 Df
SURff

Seemingly Unrelated Regressions Family Function
vglm.control

Control function for vglm
dAR1

The AR-1 Autoregressive Process
ucberk

University California Berkeley Graduate Admissions
betabinomial

Beta-binomial Distribution Family Function
Zabinom

Zero-Altered Binomial Distribution
truncweibull

Truncated Weibull Distribution Family Function
gpdUC

The Generalized Pareto Distribution
sratio

Ordinal Regression with Stopping Ratios
amlbinomial

Binomial Logistic Regression by Asymmetric Maximum Likelihood Estimation
loglinb3

Loglinear Model for Three Binary Responses
benini1

Benini Distribution Family Function
zapoisson

Zero-Altered Poisson Distribution
undocumented-methods

Undocumented Methods Functions
betaprime

The Beta-Prime Distribution
quasibinomialff

Quasi-Binomial Family Function
bifgmexp

Bivariate Farlie-Gumbel-Morgenstern Exponential Distribution Family Function
zipebcom

Exchangeable bivariate cloglog odds-ratio model from a zero-inflated Poisson distribution
zigeometric

Zero-Inflated Geometric Distribution Family Function
bifrankcop

Frank's Bivariate Distribution Family Function
yip88

Zero-Inflated Poisson Distribution (Yip (1988) algorithm)
weightsvglm

Prior and Working Weights of a VGLM fit
biclaytoncop

Clayton Copula (Bivariate) Family Function
summaryvglm

Summarizing Vector Generalized Linear Model Fits
rcqo

Constrained Quadratic Ordination
rlplot.egev

Return Level Plot for GEV Fits
hunua

Hunua Ranges Data
A1A2A3

The A1A2A3 Blood Group System
s

Defining smooths in VGAM formulae
VGAM-package

Vector Generalized Linear and Additive Models
beggs

Bacon and Eggs Data
Max

Maximums
BICvlm

Bayesian Information Criterion
vglm-class

Class ``vglm''
AR1

Autoregressive Process with Order-1 Family Function
vgam

Fitting Vector Generalized Additive Models
CommonVGAMffArguments

Common VGAM family function Arguments
alaplace

Asymmetric Laplace Distribution Family Functions
bifgmcop

Farlie-Gumbel-Morgenstern's Bivariate Distribution Family Function
Links

Link functions for VGLM/VGAM/etc. families
Rcim

Mark the Baseline of Row and Column on a Matrix data
Betageom

The Beta-Geometric Distribution
Zipois

Zero-Inflated Poisson Distribution
bilogis

Bivariate Logistic Distribution
Biamhcop

Ali-Mikhail-Haq Bivariate Distribution
betageometric

Beta-geometric Distribution Family Function
ABO

The ABO Blood Group System
Betanorm

The Beta-Normal Distribution
Coef.rrvglm

Returns Important Matrices etc. of a RR-VGLM Object
Frank

Frank's Bivariate Distribution
betaR

The Two-parameter Beta Distribution Family Function
Select

Select variables for a formula response or the RHS of a formula
Coef.qrrvglm-class

Class ``Coef.qrrvglm''
hyperg

Hypergeometric Family Function
zibinomial

Zero-Inflated Binomial Distribution Family Function
alaplaceUC

The Laplace Distribution
Benini

The Benini Distribution
bilogistic

Bivariate Logistic Distribution Family Function
smart.expression

S Expression for Smart Functions
betabinomialff

Beta-binomial Distribution Family Function
betaII

Beta Distribution of the Second Kind
betaff

The Two-parameter Beta Distribution Family Function
AB.Ab.aB.ab

The AB-Ab-aB-ab Blood Group System
Benford

Benford's Distribution
MNSs

The MNSs Blood Group System
bigumbelIexp

Gumbel's Type I Bivariate Distribution Family Function
SurvS4

Create a Survival Object
waldff

Wald Distribution Family Function
binom2.rho

Bivariate Probit Model (Family Function)
V1

V1 Flying-Bombs Hits in London
amlpoisson

Poisson Regression by Asymmetric Maximum Likelihood Estimation
cgo

Redirects the user to cqo
acat

Ordinal Regression with Adjacent Categories Probabilities
Coef.vlm

Extract Model Coefficients for VLM Objects
backPain

Data on Back Pain Prognosis, from Anderson (1984)
bigamma.mckay

Bivariate Gamma: McKay's Distribution
Biplackett

Plackett's Bivariate Copula
Coef.rrvglm-class

Class ``Coef.rrvglm''
coefvlm

Extract Model Coefficients
Opt

Optimums
posnegbinomial

Positive Negative Binomial Distribution Family Function
zero

The zero Argument in VGAM Family Functions
binomialff

Binomial Family Function
Huggins89.t1

Table 1 of Huggins (1989)
logF

Natural Exponential Family Generalized Hyperbolic Secant Distribution Family Function
rdiric

The Dirichlet distribution
Coef.qrrvglm

Returns Important Matrices etc. of a QO Object
Pareto

The Pareto Distribution
Betabinom

The Beta-Binomial Distribution
predictvglm

Predict Method for a VGLM fit
amlexponential

Exponential Regression by Asymmetric Maximum Likelihood Estimation
AICvlm

Akaike's Information Criterion
Tol

Tolerances
AA.Aa.aa

The AA-Aa-aa Blood Group System
SurvS4-class

Class "SurvS4"
simulate.vlm

Simulate Responses for VGLMs and VGAMs