File: ArchimedeanGenerator.Rd

package info (click to toggle)
fcopulae 2110.78-1
  • links: PTS
  • area: main
  • in suites: squeeze, wheezy
  • size: 952 kB
  • ctags: 57
  • sloc: fortran: 366; ansic: 43; makefile: 13
file content (138 lines) | stat: -rw-r--r-- 3,382 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
\name{ArchimedeanGenerator}

\alias{ArchimedeanGenerator}


\alias{archmList}
\alias{archmParam}
\alias{archmRange}
\alias{archmCheck}     

\alias{Phi}
\alias{PhiSlider}

\alias{Kfunc}
\alias{KfuncSlider}


\title{Bivariate Archimedean Copulae}


\description{
    
    A collection and description of functions 
    concerned with the generator function for 
    the Archimedean copula and with functions
    for setting and checking the distributional
    parameters.
    \cr
    
    Functions:
    
    \tabular{ll}{
    \code{evList} \tab Returns list of implemented Archimedean copulae, \cr
    \code{archmParam} \tab Sets default parameters for an Archimedean copula, \cr
    \code{archmRange} \tab returns the range of valid rho values, \cr
    \code{archmCheck} \tab checks if rho is in the valid range, \cr
     
    \code{Phi} \tab Computes generator Phi, inverse and derivatives, \cr
    \code{PhiSlider} \tab displays interactively generator function, \cr
    
    \code{Kfunc} \tab computes copula density and its inverse, \cr
    \code{KfuncSlider} \tab displays interactively density function. }
    
}


\usage{
archmList()
archmParam(type = archmList())
archmRange(type = archmList(), B = Inf)
archmCheck(alpha, type = archmList())
      
Phi(x, alpha = NULL, type = archmList(), inv = FALSE, deriv = paste(0:2))
PhiSlider(B = 5)

Kfunc(x, alpha = NULL, type = archmList(), inv = FALSE, lower = 1.0e-8)
KfuncSlider(B = 5)
}


\arguments{
  
    \item{alpha}{
        [Phi*][*archmCopula] - \cr
        the parameter of the Archemedean copula. A numerical value.
        }
    \item{B}{
        [archmRange] - \cr
        the maximum slider menu value when the boundary value is infinite. 
        By default this is set to \code{B=Inf}.\cr
        [*Slider] - \cr
        the maximum slider menu value when the boundary value is infinite. 
        By default this is set to \code{B=5}.
        }
    \item{deriv}{
        [Phi] - \cr
        an integer value. Should the function itself, \code{deriv="0"}, 
        or the first \code{deriv="1"}, or second \code{deriv="2"} derivative 
        be evaluated?
        }
    \item{inv}{
        [Phi][Kfunc] - \cr
        a logical flag. Should the inverse function be computed?
        }
    \item{lower}{
        [Kfunc] - \cr
        a numeric value setting the lower bound for the internal root 
        finding function \code{uniroot}.
        }
    \item{type}{
        [*archmCopula][Phi][Kfunc] - \cr
        the type of the Archimedean copula. A character string ranging 
        beween \code{"1"} and \code{"22"}. By default copula No. 1 will 
        be chosen.
        }
    \item{x}{
        [Kfunc] - \cr
        a numeric value or vector ranging between zero and one.\cr
        [Phi] - \cr
        a numeric value or vector.
        }   
            
}


\value{
    
    The function \code{Phi} returns a numeric vector with the values
    computed from the Archemedean generator, its derivatives, or its
    inverse.
    \cr
    
    The function \code{Kfunc} returns a numeric vector with the 
    values of the density and inverse for Archimedian copulae.
        
}


\author{

    Diethelm Wuertz for the Rmetrics \R-port.
    
}


\references{
RB Nelson - An Introduction to Copulas
  }

\examples{  
## archmList -
   # Return list of implemented copulae:
   archmList()
}


\keyword{models}