Skip to content
Snippets Groups Projects
Commit a43da944 authored by SANTAGOSTINI Pierre's avatar SANTAGOSTINI Pierre
Browse files

Correction: mtd (and not mcd)

parent 92d6bf69
No related branches found
No related tags found
No related merge requests found
......@@ -2,13 +2,13 @@ contourmtd <- function(nu, mu, Sigma,
xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
ylim = c(mu[2] + c(-10, 10)*Sigma[2, 2]),
zlim = NULL, npt = 30, nx = npt, ny = npt,
main = "Multivariate Cauchy density",
main = "Multivariate t density",
sub = NULL, nlevels = 10,
levels = pretty(zlim, nlevels),
tol = 1e-6, ...) {
#' Contour Plot of the Bivariate Cauchy Density
#' Contour Plot of the Bivariate \eqn{t} Density
#'
#' Draws the contour plot of the probability density of the multivariate Cauchy distribution with 2 variables
#' Draws the contour plot of the probability density of the multivariate \eqn{t} distribution with 2 variables
#' with location parameter \code{mu} and scatter matrix \code{Sigma}.
#'
#' @aliases contourmtd
......@@ -17,7 +17,7 @@ contourmtd <- function(nu, mu, Sigma,
#' xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
#' ylim = c(mu[2] + c(-10, 10)*Sigma[2, 2]),
#' zlim = NULL, npt = 30, nx = npt, ny = npt,
#' main = "Multivariate Cauchy density",
#' main = "Multivariate t density",
#' sub = NULL, nlevels = 10,
#' levels = pretty(zlim, nlevels), tol = 1e-6, ...)
#' @param nu numeric. The degrees of freedom.
......@@ -37,9 +37,9 @@ contourmtd <- function(nu, mu, Sigma,
#'
#' @references S. Kotz and Saralees Nadarajah (2004), Multivariate \eqn{t} Distributions and Their Applications, Cambridge University Press.
#'
#' @seealso \code{\link{dmtd}}: probability density of a multivariate Cauchy density
#' @seealso \code{\link{dmtd}}: probability density of a multivariate \eqn{t} density
#'
#' \code{\link{plotmtd}}: 3D plot of a bivariate Cauchy density.
#' \code{\link{plotmtd}}: 3D plot of a bivariate \eqn{t} density.
#'
#' @examples
#' nu <- 1
......@@ -52,7 +52,7 @@ contourmtd <- function(nu, mu, Sigma,
#' @export
if (length(mu)!=2 | nrow(Sigma)!=2 | ncol(Sigma)!=2)
stop(paste("contourmtd only allows plotting a Cauchy density with 2 variables.",
stop(paste("contourmtd only allows plotting a t density with 2 variables.",
"mu must be a length 2 numeric vector and Sigma must be a 2*2 square matrix.", sep = "\n"))
# Estimation of the density
......
......@@ -2,7 +2,7 @@
% Please edit documentation in R/plotmtd.R
\name{plotmtd}
\alias{plotmtd}
\title{Plot of the Bivariate Cauchy Density}
\title{Plot of the Bivariate \eqn{t} Density}
\usage{
plotmtd(nu, mu, Sigma, xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
ylim = c(mu[2] + c(-10, 10)*Sigma[2, 2]), n = 101,
......@@ -34,7 +34,7 @@ plotmtd(nu, mu, Sigma, xlim = c(mu[1] + c(-10, 10)*Sigma[1, 1]),
Returns invisibly the probability density function.
}
\description{
Plots the probability density of the multivariate Cauchy distribution with 2 variables
Plots the probability density of the multivariate \eqn{t} distribution with 2 variables
with location parameter \code{mu} and scatter matrix \code{Sigma}.
}
\examples{
......@@ -48,9 +48,9 @@ plotmtd(nu, mu, Sigma)
S. Kotz and Saralees Nadarajah (2004), Multivariate \eqn{t} Distributions and Their Applications, Cambridge University Press.
}
\seealso{
\code{\link{dmtd}}: probability density of a multivariate Cauchy density
\code{\link{dmtd}}: probability density of a multivariate \eqn{t} density
\code{\link{contourmtd}}: contour plot of a bivariate Cauchy density.
\code{\link{contourmtd}}: contour plot of a bivariate \eqn{t} density.
\code{\link{plot3d.function}}: plot a function of two variables.
}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment