[spcopula-commits] r159 - pkg/man

[noreply at r-forge.r-project.org]

Author: ben_graeler
Date: 2016-09-14 12:58:12 +0200 (Wed, 14 Sep 2016)
New Revision: 159

Added:
   pkg/man/mixtureCopula-class.Rd
   pkg/man/mixtureCopula.Rd
Log:
adding man files for the mixtureCopula

Added: pkg/man/mixtureCopula-class.Rd
===================================================================
--- pkg/man/mixtureCopula-class.Rd	                        (rev 0)
+++ pkg/man/mixtureCopula-class.Rd	2016-09-14 10:58:12 UTC (rev 159)
@@ -0,0 +1,50 @@
+\name{mixtureCopula-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{mixtureCopula-class}
+\alias{dduCopula,ANY,mixtureCopula-method}
+\alias{ddvCopula,ANY,mixtureCopula-method}
+\alias{fitCopula,mixtureCopula-method}
+\alias{invdduCopula,numeric,mixtureCopula,numeric-method}
+\alias{invddvCopula,numeric,mixtureCopula,numeric-method}
+
+\title{Class \code{"mixtureCopula"}}
+\description{
+The \code{mixtureCopula} contains two copulas that are combined in a convex manner to a new copula.
+}
+\section{Objects from the Class}{
+Objects can be created by calls of the form \code{new("mixtureCopula", ...)} or by calling the constructor \code{\link{mixtureCopula}}.
+}
+\section{Slots}{
+  \describe{
+    \item{\code{memberCops}:}{Object of class \code{"list"}: holding the copulas used in the convex combination. }
+    \item{\code{dimension}:}{Object of class \code{"integer"}: the dimension of both input and the resulting copula. }
+    \item{\code{parameters}:}{Object of class \code{"numeric"}: the set of parameters for the first and second copula as well as the mixing coefficient.}
+    \item{\code{param.names}:}{Object of class \code{"character"}: names of all parameters. }
+    \item{\code{param.lowbnd}:}{Object of class \code{"numeric"}: lower bounds of all parameters. }
+    \item{\code{param.upbnd}:}{Object of class \code{"numeric"}: upper bounds of all parameters. }
+    \item{\code{fullname}:}{Object of class \code{"character"}: the name of the copula. }
+  }
+}
+\section{Extends}{
+Class \code{"\linkS4class{copula}"}, directly.
+Class \code{"\linkS4class{parCopula}"}, by class "copula", distance 2.
+Class \code{"\linkS4class{Copula}"}, by class "copula", distance 3.
+}
+\section{Methods}{
+  \describe{
+    \item{dduCopula}{\code{signature(u = "ANY", copula = "mixtureCopula")}: ... }
+    \item{ddvCopula}{\code{signature(u = "ANY", copula = "mixtureCopula")}: ... }
+    \item{fitCopula}{\code{signature(copula = "mixtureCopula")}: ... }
+    \item{invdduCopula}{\code{signature(u = "numeric", copula = "mixtureCopula", y = "numeric")}: ... }
+    \item{invddvCopula}{\code{signature(v = "numeric", copula = "mixtureCopula", y = "numeric")}: ... }
+	 }
+}
+
+\author{
+Benedikt Graeler}
+
+\examples{
+showClass("mixtureCopula")
+}
+\keyword{classes}

Added: pkg/man/mixtureCopula.Rd
===================================================================
--- pkg/man/mixtureCopula.Rd	                        (rev 0)
+++ pkg/man/mixtureCopula.Rd	2016-09-14 10:58:12 UTC (rev 159)
@@ -0,0 +1,27 @@
+\name{mixtureCopula}
+\alias{mixtureCopula}
+
+\title{
+Constructor of a mixture copula}
+\description{
+An instance of a convex mixture of two copulas is generated.
+}
+\usage{
+mixtureCopula(param = c(0.2, 0.2, 0.5), memberCops = c(normalCopula(0), claytonCopula(1)))
+}
+
+\arguments{
+  \item{param}{A numeric vector: the set of parameters for the first and second copula appended by the mixture coefficient.}
+  \item{memberCops}{A list of two copulas.}
+}
+\value{
+An object of class \linkS4class{mixtureCopula}}
+\author{
+Benedikt Graeler}
+
+\examples{
+
+mixCop <- mixtureCopula()
+
+persp(mixCop, dCopula)
+}