File: dist-distCheck.Rd

package info (click to toggle)
fbasics 4052.98-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,020 kB
  • sloc: ansic: 738; makefile: 14
file content (44 lines) | stat: -rw-r--r-- 998 bytes parent folder | download | duplicates (3)
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
\name{distCheck}
\alias{distCheck}


\title{Distribution check}

\description{
  Tests properties of an \R implementation of a distribution, i.e., of
  all four of its \dQuote{dpqr} functions.
}

\usage{
distCheck(fun = "norm", n = 1000, robust = TRUE, subdivisions = 100, \dots)
}
\arguments{
  \item{fun}{
    a character string, the name of the distribution.
  }
  \item{n}{
    an integer specifying the number of random variates to be
    generated.
  }
  \item{robust}{
    logical flag, should robust estimates be used? By default
    \code{TRUE}.
  }
  \item{subdivisions}{
    integer specifying the numbers of subdivisions in integration.
  }
  \item{\dots}{
    the distributional parameters.
  }
}

\examples{
distCheck("norm", mean = 1, sd = 1)

distCheck("lnorm", meanlog = 0.5, sdlog = 2, robust=FALSE)
## here, true E(X) = exp(mu + 1/2 sigma^2) = exp(.5 + 2) = exp(2.5) = 12.182
## and      Var(X) = exp(2*mu + sigma^2)*(exp(sigma^2) - 1) =       7954.67
}
\keyword{distribution}