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

« back to all changes in this revision

Viewing changes to man/dst2.plot.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:
1
 
\name{dst2.plot}
2
 
\alias{dst2.plot}
3
 
\title{
4
 
Plot of bivariate skew-\eqn{t} density function
5
 
}
6
 
\description{
7
 
Produces a contour plot of the density function of a bivariate 
8
 
skew-\eqn{t} variate.
9
 
}
10
 
\usage{dst2.plot(x, y, xi, Omega, alpha, df, dp = NULL, ...) }
11
 
 
12
 
\arguments{
13
 
\item{x}{
14
 
vector of values of the first component.
15
 
}
16
 
\item{y}{
17
 
vector of values of the second component.
18
 
}
19
 
\item{xi}{
20
 
a vector of length 2 containing the location parameter.
21
 
}
22
 
\item{Omega}{
23
 
a 2 by 2 matrix containing a covariance matrix.
24
 
}
25
 
\item{alpha}{
26
 
a vector of length 2 containing the shape parameter.
27
 
}
28
 
\item{df}{
29
 
a positive number, representing the degrees of freedom .
30
 
}
31
 
\item{dp}{
32
 
  a list with components named \code{xi, Omega, alpha, df}, containing
33
 
  quantities as described above. If this parameter is set, then the
34
 
  individual parameters must not be.
35
 
  }
36
 
\item{...}{
37
 
additional parameters to be passed to \code{contour}.
38
 
}}
39
 
\value{
40
 
A list containing the original input parameters plus a matrix
41
 
containing the density function evaluated at the grid formed 
42
 
by the \code{x} and \code{y} values. 
43
 
}
44
 
\details{Typical usages are
45
 
\preformatted{%
46
 
dst2.plot(x, y, xi, Omega, alpha, df, ...)
47
 
dst2.plot(x, y, dp=, ...)
48
 
}
49
 
  The density function is evalutate at the grid of points whose
50
 
  coordinates are given by vectors \code{x} and \code{y}.
51
 
  The actual computation is done by the  function \code{dmst}.
52
 
  A contour level plot is produced on the graphical window. 
53
 
}
54
 
 
55
 
\section{Background}{
56
 
The family of multivariate skew-t distributions is an extension of the 
57
 
multivariate Student's \eqn{t} family, via the introduction of a \code{shape} 
58
 
parameter which regulates skewness; when \code{shape=0}, the skew-\eqn{t}
59
 
distribution reduces to the usual \eqn{t} distribution. 
60
 
When \code{df=Inf} the distribution reduces to the multivariate skew-normal 
61
 
one; see \code{dmsn}. See the reference below for additional information.
62
 
}
63
 
\references{
64
 
Azzalini, A. and Capitanio, A. (2003).
65
 
  Distributions generated by perturbation of symmetry 
66
 
  with emphasis on a multivariate skew \eqn{t} distribution.
67
 
  \emph{J.Roy. Statist. Soc. B} \bold{65}, 367--389.
68
 
}
69
 
\seealso{
70
 
\code{\link{dmst}}, \code{\link{dsn2.plot}}
71
 
}
72
 
\examples{
73
 
x <- y <- seq(-5, 5, length=35)
74
 
dst2.plot(x, y, c(-1,2), diag(c(1,2.5)), c(2,-3), df=5)
75
 
}
76
 
\keyword{distribution}
77