← Back to branch summary

~ubuntu-branches/ubuntu/trusty/r-cran-sn/trusty

« back to all changes in this revision

Viewing changes to man/summary.SECdistr-class.Rd

  • Committer: Package Import Robot
  • Author(s): Dirk Eddelbuettel
  • Date: 2014-01-14 06:28:00 UTC
  • mfrom: (1.1.11)
  • Revision ID: package-import@ubuntu.com-20140114062800-yntgbps6kq5et10c
Tags: 1.0-0-1
* New upstream release

* debian/control: Add (Build-)Depends on r-cran-numderiv nomnormt (>= 1.3-1)

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/summary.SECdistr-class.Rd
 
1
%  file sn/man/summary.SECdistr-class.Rd
 
2
%  This file is a component of the package 'sn' for R
 
3
%  copyright (C) 2013 Adelchi Azzalini
 
4
%---------------------
 
5
\name{summary.SECdistrMv-class}
 
6
\Rdversion{1.1}
 
7
\docType{class}
 
8
\alias{summary.SECdistrMv-class}
 
9
\alias{summary.SECdistrUv-class}
 
10
\alias{show,summary.SECdistrMv-method}
 
11
\alias{show,summary.SECdistrUv-method}
 
12
 
 
13
\title{Classes \code{summary.SECdistrMv} and \code{summary.SECdistrUv}}
 
14
 
 
15
\description{Summaries of objects of classes \code{SECdistrMv} and 
 
16
\code{SECdistrUv}}
 
17
 
 
18
\section{Objects from the Class}{
 
19
Objects can be created by calls of type \code{summary(object)} when 
 
20
\code{object} is  of class either \code{"SECdistrMv"} or \code{"SECdistrUv"}.}
 
21
 
 
22
\section{Slots}{
 
23
  \describe{
 
24
    \item{\code{family}:}{A character string which represents
 
25
          the parametric family of \acronym{SEC} type }
 
26
    \item{\code{dp}:}{Object of class \code{"list"} or \code{"vector"} for
 
27
        \code{"SECdistrMv"} and \code{"SECdistrUv"}, respectively}
 
28
    \item{\code{name}:}{Object of class \code{"character"} with the name of 
 
29
        distribution }
 
30
    \item{\code{compNames}:}{For \code{"SECdistrMv"} objects, a character 
 
31
        vector with names of the components of the multivariate distribution}
 
32
    \item{\code{cp}:}{Object of class \code{"list"} or \code{"vector"} for
 
33
        \code{"SECdistrMv"} and \code{"SECdistrUv"}, respectively}
 
34
    \item{\code{cp.type}:}{a character string of the \acronym{CP} version}
 
35
    \item{\code{aux}:}{A list of auxiliary quantities }
 
36
  }
 
37
}
 
38
\section{Methods}{
 
39
  \describe{
 
40
    \item{show}{\code{signature(object = "summary.SECdistrMv")}: ... }
 
41
    \item{show}{\code{signature(object = "summary.SECdistrUv")}: ... }
 
42
         }
 
43
}
 
44
 
 
45
%\references{%%  ~~put references to the literature/web site here~~}
 
46
 
 
47
\author{Adelchi Azzalini}
 
48
 
 
49
% \note{%%  ~~further notes~~}
 
50
 
 
51
%% ~Make other sections like Warning with \section{Warning }{....} ~
 
52
 
 
53
\seealso{\code{\link{summary.SECdistrMv}}, \code{\link{summary.SECdistrUv}},
 
54
 
 
55
\code{\link{makeSECdistr}}, \code{\link{dp2cp}} }
 
56
 
 
57
% \examples{showClass("summary.SECdistrMv")}
 
58
\keyword{classes}