diff --git a/man/contourmvggd.Rd b/man/contourmggd.Rd similarity index 87% rename from man/contourmvggd.Rd rename to man/contourmggd.Rd index 4306947cf310c3bf565e715dc977baab4877d268..84b2843713b2b2f0e0993c0ab6571a4e226894f8 100644 --- a/man/contourmvggd.Rd +++ b/man/contourmggd.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/contourmvggd.R -\name{contourmvggd} -\alias{contourmvggd} +\name{contourmggd} +\alias{contourmggd} \title{Contour Plot of the Bivariate Generalised Gaussian Density} \usage{ -contourmvggd(mu, Sigma, beta, +contourmggd(mu, Sigma, beta, 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, @@ -31,7 +31,7 @@ contourmvggd(mu, Sigma, beta, \item{nlevels, levels}{arguments to be passed to the \code{\link{contour}} function.} -\item{tol}{tolerance (relative to largest variance) for numerical lack of positive-definiteness in Sigma, for the estimation of the density. see \code{\link{mvdggd}}.} +\item{tol}{tolerance (relative to largest variance) for numerical lack of positive-definiteness in Sigma, for the estimation of the density. see \code{\link{dmggd}}.} \item{...}{additional arguments to \code{\link{plot.window}}, \code{\link{title}}, \code{\link{Axis}} and \code{\link{box}}, typically \link{graphical parameters} such as \code{cex.axis}.} } @@ -46,7 +46,7 @@ with mean vector \code{mu}, dispersion matrix \code{Sigma} and shape parameter \ mu <- c(1, 4) Sigma <- matrix(c(0.8, 0.2, 0.2, 0.2), nrow = 2) beta <- 0.74 -contourmvggd(mu, Sigma, beta) +contourmggd(mu, Sigma, beta) } \references{ @@ -55,9 +55,9 @@ Commun. Statist. 1998, Theory Methods, col. 27, no. 23, p 589-600. \doi{10.1080/03610929808832115} } \seealso{ -\code{\link{plotmvggd}}: plot of a bivariate generalised Gaussian density. +\code{\link{plotmggd}}: plot of a bivariate generalised Gaussian density. -\code{\link{mvdggd}}: Probability density of a multivariate generalised Gaussian distribution. +\code{\link{dmggd}}: Probability density of a multivariate generalised Gaussian distribution. } \author{ Pierre Santagostini, Nizar Bouhlel diff --git a/man/estparmvggd.Rd b/man/estparmggd.Rd similarity index 87% rename from man/estparmvggd.Rd rename to man/estparmggd.Rd index 09753a82f436256c9fef5a870d3f5cc29005325c..a6790130531637a41e154fd51d791d486a0ede04 100644 --- a/man/estparmvggd.Rd +++ b/man/estparmggd.Rd @@ -1,10 +1,10 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/estparmvggd.R -\name{estparmvggd} -\alias{estparmvggd} +\name{estparmggd} +\alias{estparmggd} \title{Estimation of the Parameters of a Multivariate Generalized Gaussian Distribution} \usage{ -estparmvggd(x, eps = 1e-6, display = FALSE, plot = display) +estparmggd(x, eps = 1e-6, display = FALSE, plot = display) } \arguments{ \item{x}{numeric matrix or data frame.} @@ -39,10 +39,10 @@ The precision for the estimation of \code{beta} is given by the \code{eps} param mu <- c(0, 1, 4) Sigma <- matrix(c(0.8, 0.3, 0.2, 0.3, 0.2, 0.1, 0.2, 0.1, 0.2), nrow = 3) beta <- 0.74 -x <- mvrggd(100, mu, Sigma, beta) +x <- rmggd(100, mu, Sigma, beta) # Estimation of the parameters -estparmvggd(x) +estparmggd(x) } \references{ @@ -51,9 +51,9 @@ IEEE Trans. Signal Processing, vol. 61 no. 23, p. 5960-5971, Dec. 2013. \doi{DOI: 10.1109/TSP.2013.2282909} } \seealso{ -\code{\link{mvdggd}}: probability density of a MGGD. +\code{\link{dmggd}}: probability density of a MGGD. -\code{\link{mvrggd}}: random generation from a MGGD. +\code{\link{rmggd}}: random generation from a MGGD. } \author{ Pierre Santagostini, Nizar Bouhlel diff --git a/man/kldggd.Rd b/man/kldggd.Rd index 2b3ed730357a973a3a4116b6bb695a8df0858636..ce38959b5ff3d6fd375ac4de2c9106ec56bbdf6c 100644 --- a/man/kldggd.Rd +++ b/man/kldggd.Rd @@ -74,7 +74,7 @@ IEEE Signal Processing Letters, vol. 26 no. 7, July 2019. \doi{10.1109/LSP.2019.2915000} } \seealso{ -\link{mvdggd}: probability density of a MGGD. +\link{dmggd}: probability density of a MGGD. } \author{ Pierre Santagostini, Nizar Bouhlel