File: summary.gl1ce.Rd

package info (click to toggle)
r-cran-lasso2 1.2-22-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 828 kB
  • sloc: ansic: 777; sh: 13; makefile: 2
file content (48 lines) | stat: -rw-r--r-- 1,900 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
\name{summary.gl1ce}
\alias{summary.gl1ce}
\alias{print.summary.gl1ce}
\title{Summary Method for Generalized L1 Constrained Regression Models}
\description{
  Returns (and prints) a summary list for fitted generalized L1
  constrained regression models.
}
\usage{
\method{summary}{gl1ce}(object, dispersion = NULL, correlation = FALSE, \dots)
\method{print}{summary.gl1ce}(x, digits = max(3, getOption("digits") - 3), \dots)
}
\arguments{
  \item{object}{
    fitted \code{gl1ce} model object.  This is assumed to be the
    result of some fit that produces an object inheriting from
    the class \code{gl1ce}, in the sense that the components returned
    by the gl1ce() function will be available.
  }
  \item{dispersion}{prescribed dispersion, see \code{\link{summary.glm}}.}
  \item{correlation}{logical indicating if the correlation matrix should
    be returned as well.}
  \item{x}{object of class \code{summary.gl1ce}.}
  \item{digits, \dots}{further arguments for the \code{print} method.}
}
\value{
  an object of class \code{summary.gl1ce} (for which there's a
  \code{print} method).
  It is basically a list with the following components:

  \item{call}{as contained on object}
  \item{residuals}{the deviance residuals, as produced by
    \code{residuals(object, type = "deviance")}.}
  \item{coefficients}{the coefficients of the model.}
  \item{family}{
    the family of models to which object belongs, along with the
    variance and link functions for that model.}
  \item{bound}{the bound used in fitting this model}
  \item{Lagrangian}{the Lagrangian of the model}
}
\details{
  This function is a method for the generic function summary for  class
  \code{gl1ce}.
  It can be invoked by calling summary for an object of the appropriate class,
  or directly by calling  summary.gl1ce  regardless of the class of the object.
}
\keyword{models}
% Converted by Sd2Rd version 1.21.