[Distr-commits] r535 - in branches/distr-2.2/pkg: distrEllipse distrEllipse/man distrMod/man distrTEst/man distrTeach/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Thu Aug 20 15:57:59 CEST 2009
Author: stamats
Date: 2009-08-20 15:57:59 +0200 (Thu, 20 Aug 2009)
New Revision: 535
Modified:
branches/distr-2.2/pkg/distrEllipse/NAMESPACE
branches/distr-2.2/pkg/distrEllipse/man/EllipticalDistribution-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/EllipticalParameter-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution.Rd
branches/distr-2.2/pkg/distrEllipse/man/MvnormDistribution-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/MvnormParameter-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd
branches/distr-2.2/pkg/distrEllipse/man/SphericalDistribution-class.Rd
branches/distr-2.2/pkg/distrMod/man/BiasType-class.Rd
branches/distr-2.2/pkg/distrMod/man/Confint-class.Rd
branches/distr-2.2/pkg/distrMod/man/Estimate-class.Rd
branches/distr-2.2/pkg/distrMod/man/EvenSymmetric-class.Rd
branches/distr-2.2/pkg/distrMod/man/FunSymmList-class.Rd
branches/distr-2.2/pkg/distrMod/man/FunctionSymmetry-class.Rd
branches/distr-2.2/pkg/distrMod/man/L2GroupFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/L2LocationFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/L2LocationScaleFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/L2ParamFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/L2ScaleFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/MCEstimate-class.Rd
branches/distr-2.2/pkg/distrMod/man/MDEstimator.Rd
branches/distr-2.2/pkg/distrMod/man/NonSymmetric-class.Rd
branches/distr-2.2/pkg/distrMod/man/NormType-class.Rd
branches/distr-2.2/pkg/distrMod/man/OddSymmetric-class.Rd
branches/distr-2.2/pkg/distrMod/man/ParamFamParameter-class.Rd
branches/distr-2.2/pkg/distrMod/man/ParamFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/ProbFamily-class.Rd
branches/distr-2.2/pkg/distrMod/man/QFnorm-class.Rd
branches/distr-2.2/pkg/distrMod/man/RiskType-class.Rd
branches/distr-2.2/pkg/distrMod/man/asBias-class.Rd
branches/distr-2.2/pkg/distrMod/man/asCov-class.Rd
branches/distr-2.2/pkg/distrMod/man/asGRisk-class.Rd
branches/distr-2.2/pkg/distrMod/man/asHampel-class.Rd
branches/distr-2.2/pkg/distrMod/man/asMSE-class.Rd
branches/distr-2.2/pkg/distrMod/man/asRisk-class.Rd
branches/distr-2.2/pkg/distrMod/man/asRiskwithBias-class.Rd
branches/distr-2.2/pkg/distrMod/man/asSemivar-class.Rd
branches/distr-2.2/pkg/distrMod/man/asUnOvShoot-class.Rd
branches/distr-2.2/pkg/distrMod/man/asymmetricBias-class.Rd
branches/distr-2.2/pkg/distrMod/man/fiBias-class.Rd
branches/distr-2.2/pkg/distrMod/man/fiCov-class.Rd
branches/distr-2.2/pkg/distrMod/man/fiHampel-class.Rd
branches/distr-2.2/pkg/distrMod/man/fiMSE-class.Rd
branches/distr-2.2/pkg/distrMod/man/fiRisk-class.Rd
branches/distr-2.2/pkg/distrMod/man/fiUnOvShoot-class.Rd
branches/distr-2.2/pkg/distrMod/man/onesidedBias-class.Rd
branches/distr-2.2/pkg/distrMod/man/symmetricBias-class.Rd
branches/distr-2.2/pkg/distrMod/man/trAsCov-class.Rd
branches/distr-2.2/pkg/distrMod/man/trFiCov-class.Rd
branches/distr-2.2/pkg/distrTEst/man/Evaluation-class.Rd
branches/distr-2.2/pkg/distrTeach/man/IllustLLN.Rd
Log:
some reformating of Rd-files - no notes, warnings or errors using R 2.10.0 (2009-08-19 r49319)
Modified: branches/distr-2.2/pkg/distrEllipse/NAMESPACE
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/NAMESPACE 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/NAMESPACE 2009-08-20 13:57:59 UTC (rev 535)
@@ -1,5 +1,4 @@
import("methods")
-importFrom("stats", "simulate")
importFrom("setRNG", "setRNG")
import("mvtnorm")
import("distr")
Modified: branches/distr-2.2/pkg/distrEllipse/man/EllipticalDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/EllipticalDistribution-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/EllipticalDistribution-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -27,40 +27,39 @@
}
\section{Slots}{
\describe{
- \item{\code{img}:}{Object of class \code{"Reals"}. }
- \item{\code{param}:}{Object of class \code{"EllipticalParameter"}. }
- \item{\code{r}:}{function with argument \code{n}; random number generator}
- \item{\code{d}:}{optional function; in case it exists:
+ \item{\code{img}}{Object of class \code{"Reals"}. }
+ \item{\code{param}}{Object of class \code{"EllipticalParameter"}. }
+ \item{\code{r}}{function with argument \code{n}; random number generator}
+ \item{\code{d}}{optional function; in case it exists:
the density of the distribution}
- \item{\code{p}:}{optional function; in case it is non-null:
+ \item{\code{p}}{optional function; in case it is non-null:
the cdf of the distribution evaluated on rectangles, i.e. if a random
variable \code{X} is distributed according to an \code{object} of class
\code{"EllipticalDistribution"},
for \code{q} a matrix of dimension \eqn{d \times n}{d x n} \code{p(object)(q)}
returns, for each of the \code{n} columns
\eqn{P(X_i\leq q_i,\;i=1,\ldots,d)}{P(X[i]<= q[i],\;i=1,\dots,d)}.}
- \item{\code{q}:}{optional function; in case it is non-null:
+ \item{\code{q}}{optional function; in case it is non-null:
the quantile of the distribution evaluated on rectangles, i.e. if a random
variable \code{X} is distributed according to an \code{object} of class
\code{"EllipticalDistribution"},
for \code{p} a vector of length \eqn{n}, returns, for each of the
\code{n} components the infinimal number \eqn{q_j}{q[j]} such that
\eqn{P(X_i\leq q_j,\;i=1,\ldots,d)\ge p_j}{P(X[i]<= q[j],\;i=1,\dots,d)>= p[j]}.}
- \item{\code{radDistr}:}{an object of class \code{UnivariateDistribution} with positive
+ \item{\code{radDistr}}{an object of class \code{UnivariateDistribution} with positive
support, i.e. \code{p(radDistr)(0)==0}; the radial distribution. }
- \item{\code{.withArith}:}{logical: used internally to issue warnings as to
+ \item{\code{.withArith}}{logical: used internally to issue warnings as to
interpretation of arithmetics}
- \item{\code{.withSim}:}{logical: used internally to issue warnings as to
+ \item{\code{.withSim}}{logical: used internally to issue warnings as to
accuracy}
- \item{\code{.logExact}:}{logical: used internally to flag the case where
+ \item{\code{.logExact}}{logical: used internally to flag the case where
there are explicit formulae for the log version of density, cdf, and
quantile function}
- \item{\code{.lowerExact}:}{logical: used internally to flag the case where
+ \item{\code{.lowerExact}}{logical: used internally to flag the case where
there are explicit formulae for the lower tail version of cdf and quantile
function}
- \item{\code{Symmetry}:}{object of class \code{"EllipticalSymmetry"} about
- center \code{loc};
- used internally to avoid unnecessary calculations.}
+ \item{\code{Symmetry}}{object of class \code{"EllipticalSymmetry"} about
+ center \code{loc}; used internally to avoid unnecessary calculations.}
}
}
\section{Extends}{
@@ -88,18 +87,18 @@
\item{var}{\code{signature(x = "EllipticalDistribution")}:
expectation of an elliptically symmetric distribution; exact.
}
- \item{\code{+}}{\code{signature(e1 = "EllipticalDistribution", e2 = "numeric")}:{
+ \item{\code{+}}{\code{signature(e1 = "EllipticalDistribution", e2 = "numeric")}:
affine linear transformation; exact.
- }}
- \item{\code{-}}{\code{signature(e1 = "EllipticalDistribution", e2 = "numeric")}:{
+ }
+ \item{\code{-}}{\code{signature(e1 = "EllipticalDistribution", e2 = "numeric")}:
affine linear transformation; exact.
- }}
- \item{\code{*}}{\code{signature(e1 = "EllipticalDistribution", e2 = "numeric")}:{
+ }
+ \item{\code{*}}{\code{signature(e1 = "EllipticalDistribution", e2 = "numeric")}:
affine linear transformation; exact.
- }}
- \item{\code{\%*\%}}{\code{signature(e1 = "numeric", e2 = "EllipticalDistribution")}:{
+ }
+ \item{\code{\%*\%}}{\code{signature(e1 = "numeric", e2 = "EllipticalDistribution")}:
affine linear transformation; exact.
- }}
+ }
\item{coerce}{\code{signature(from = "EllipticalDistribution", to = "UnivariateDistribution")}:
create a \code{UnivariateDistribution} object from a (one-dimensional)
elliptically symmetric distribution. }
Modified: branches/distr-2.2/pkg/distrEllipse/man/EllipticalParameter-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/EllipticalParameter-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/EllipticalParameter-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -17,10 +17,10 @@
}
\section{Slots}{
\describe{
- \item{\code{loc}:}{ numeric; center / location of the distribution. }
- \item{\code{scale}:}{ matrix; the scale matrix; the number of rows of this
+ \item{\code{loc}}{ numeric; center / location of the distribution. }
+ \item{\code{scale}}{ matrix; the scale matrix; the number of rows of this
matrix must be the same as the length of \code{location}.}
- \item{\code{name}:}{ default name is
+ \item{\code{name}}{ default name is
\dQuote{parameter of a Elliptical distribution}. }
}
}
Modified: branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -36,26 +36,26 @@
}
\section{Slots}{
\describe{
- \item{\code{mixCoeff}:}{Object of class \code{"numeric"}: a vector of
+ \item{\code{mixCoeff}}{Object of class \code{"numeric"}: a vector of
probabilities for the mixing components.}
- \item{\code{mixDistr}:}{Object of class \code{"MultivarDistrList"}: a list of
+ \item{\code{mixDistr}}{Object of class \code{"MultivarDistrList"}: a list of
multivariate distributions containing the mixing components; must be of same
length as \code{mixCoeff}.}
- \item{\code{img}:}{Object of class \code{"Reals"}: the space of the image of this distribution which has dimension 1
+ \item{\code{img}}{Object of class \code{"Reals"}: the space of the image of this distribution which has dimension 1
and the name "Real Space" }
- \item{\code{param}:}{Object of class \code{"Parameter"}: the parameter of this distribution, having only the
+ \item{\code{param}}{Object of class \code{"Parameter"}: the parameter of this distribution, having only the
slot name "Parameter of a discrete distribution" }
- \item{\code{r}:}{Object of class \code{"function"}: generates random numbers}
- \item{\code{d}:}{fixed to \code{NULL}}
- \item{\code{p}:}{Object of class \code{"OptionalFunction"}: if non-null cumulative distribution function}
- \item{\code{q}:}{Object of class \code{"OptionalFunction"}: if non-null quantile function}
- \item{\code{.withArith}:}{logical: used internally to issue warnings as to interpretation of arithmetics}
- \item{\code{.withSim}:}{logical: used internally to issue warnings as to accuracy}
- \item{\code{.logExact}:}{logical: used internally to flag the case where there are explicit formulae for the
+ \item{\code{r}}{Object of class \code{"function"}: generates random numbers}
+ \item{\code{d}}{fixed to \code{NULL}}
+ \item{\code{p}}{Object of class \code{"OptionalFunction"}: if non-null cumulative distribution function}
+ \item{\code{q}}{Object of class \code{"OptionalFunction"}: if non-null quantile function}
+ \item{\code{.withArith}}{logical: used internally to issue warnings as to interpretation of arithmetics}
+ \item{\code{.withSim}}{logical: used internally to issue warnings as to accuracy}
+ \item{\code{.logExact}}{logical: used internally to flag the case where there are explicit formulae for the
log version of density, cdf, and quantile function}
- \item{\code{.lowerExact}:}{logical: used internally to flag the case where there are explicit formulae for the
+ \item{\code{.lowerExact}}{logical: used internally to flag the case where there are explicit formulae for the
lower tail version of cdf and quantile function}
- \item{\code{Symmetry}:}{object of class \code{"DistributionSymmetry"};
+ \item{\code{Symmetry}}{object of class \code{"DistributionSymmetry"};
used internally to avoid unnecessary calculations.}
}
}
Modified: branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/MultivarMixingDistribution.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -19,7 +19,7 @@
% \item{withSimplify}{\code{"logical"}: shall the return value be piped through a
% call to \code{simplifyD}?}
}
-\details{If \code{mixCoeff} is missing, all elements in \code{\ldots}
+\details{If \code{mixCoeff} is missing, all elements in \code{\dots}
are equally weighted.}
\value{Object of class \code{"MultivarMixingDistribution"}, or if
argument \code{withSimplify} is \code{TRUE} and the resulting
Modified: branches/distr-2.2/pkg/distrEllipse/man/MvnormDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvnormDistribution-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvnormDistribution-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -18,18 +18,18 @@
}
\section{Slots}{
\describe{
- \item{\code{img}:}{Object of class \code{"Reals"}. }
- \item{\code{param}:}{Object of class \code{"MVtParameter"}. }
- \item{\code{r}:}{function with argument \code{n}; random number generator}
- \item{\code{d}:}{ the density of this distribution, \code{\link[mvtnorm]{pmvnorm}}}
- \item{\code{p}:}{the (vectorized) function \code{\link[mvtnorm]{pmvnorm}}.}
- \item{\code{q}:}{the (vectorized) function \code{\link[mvtnorm]{qmvnorm}}.}
- \item{\code{radDistr}:}{the distribution \code{sqrt(Chisq(df=dim0))}}
- \item{\code{.withArith}:}{FALSE}
- \item{\code{.withSim}:}{FALSE}
- \item{\code{.logExact}:}{TRUE}
- \item{\code{.lowerExact}:}{TRUE}
- \item{\code{Symmetry}:}{object of class \code{"EllipticalSymmetry"} about
+ \item{\code{img}}{Object of class \code{"Reals"}. }
+ \item{\code{param}}{Object of class \code{"MVtParameter"}. }
+ \item{\code{r}}{function with argument \code{n}; random number generator}
+ \item{\code{d}}{ the density of this distribution, \code{\link[mvtnorm]{pmvnorm}}}
+ \item{\code{p}}{the (vectorized) function \code{\link[mvtnorm]{pmvnorm}}.}
+ \item{\code{q}}{the (vectorized) function \code{\link[mvtnorm]{qmvnorm}}.}
+ \item{\code{radDistr}}{the distribution \code{sqrt(Chisq(df=dim0))}}
+ \item{\code{.withArith}}{FALSE}
+ \item{\code{.withSim}}{FALSE}
+ \item{\code{.logExact}}{TRUE}
+ \item{\code{.lowerExact}}{TRUE}
+ \item{\code{Symmetry}}{object of class \code{"EllipticalSymmetry"} about
center \code{loc}; used internally to avoid unnecessary calculations.}
}}
\section{Extends}{
@@ -46,7 +46,6 @@
\item{mean}{\code{signature(object = "MVNormDistribution")}: wrapped access method for
slot \code{location} of slot \code{param}. }
-
}
}
\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
Modified: branches/distr-2.2/pkg/distrEllipse/man/MvnormParameter-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvnormParameter-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvnormParameter-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -6,17 +6,17 @@
\alias{sigma}
\alias{sigma,MVNormParameter-method}
-\title{Paramter of a multivariate normal distribution}
+\title{Paramter of a multivariate normal distribution}
\description{The class of the parameter of MVNorm distributions.}
\section{Objects from the Class}{
Objects can be created by calls of the form \code{new("MVNormParameter", ...)}.
}
\section{Slots}{
\describe{
- \item{\code{loc}:}{ numeric; center / location of the distribution. }
- \item{\code{scale}:}{ matrix; the scale matrix; the number of rows of this
+ \item{\code{loc}}{ numeric; center / location of the distribution. }
+ \item{\code{scale}}{ matrix; the scale matrix; the number of rows of this
matrix must be the same as the length of \code{location}.}
- \item{\code{name}:}{ default name is
+ \item{\code{name}}{ default name is
\dQuote{parameter of a Elliptical distribution}. }
}
}
Modified: branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvtDistribution-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -19,24 +19,24 @@
}
\section{Slots}{
\describe{
- \item{\code{img}:}{Object of class \code{"Reals"}. }
- \item{\code{param}:}{Object of class \code{"MVtParameter"}. }
- \item{\code{r}:}{function with argument \code{n}; random number generator}
- \item{\code{d}:}{ the density of this distribution, \code{\link[mvtnorm]{dmvt}}}
- \item{\code{p}:}{the (vectorized) function \code{\link[mvtnorm]{pmvt}}.}
- \item{\code{q}:}{the (vectorized) function \code{\link[mvtnorm]{qmvt}}.}
- \item{\code{radDistr}:}{an object of class \code{AbscontDistribution}
+ \item{\code{img}}{Object of class \code{"Reals"}. }
+ \item{\code{param}}{Object of class \code{"MVtParameter"}. }
+ \item{\code{r}}{function with argument \code{n}; random number generator}
+ \item{\code{d}}{ the density of this distribution, \code{\link[mvtnorm]{dmvt}}}
+ \item{\code{p}}{the (vectorized) function \code{\link[mvtnorm]{pmvt}}.}
+ \item{\code{q}}{the (vectorized) function \code{\link[mvtnorm]{qmvt}}.}
+ \item{\code{radDistr}}{an object of class \code{AbscontDistribution}
with density
\deqn{{\rm dim} {({\rm dim}+{\rm df}-1)/2\choose{{\rm df}/2-1}} x^{{\rm dim}-1} {\rm df}^{-{\rm dim}/2}/
(1+x^2/{\rm df})^{({\rm dim}+{\rm df})/2}}{
dim * choose((dim+df-1)/2, (df-1)/2) * x ^{dim-1} * df^(-dim/2) *
(1+x^2/df)^{-(dim+df)/2}}
}
- \item{\code{.withArith}:}{FALSE}
- \item{\code{.withSim}:}{FALSE}
- \item{\code{.logExact}:}{TRUE}
- \item{\code{.lowerExact}:}{TRUE}
- \item{\code{Symmetry}:}{object of class \code{"EllipticalSymmetry"} about
+ \item{\code{.withArith}}{FALSE}
+ \item{\code{.withSim}}{FALSE}
+ \item{\code{.logExact}}{TRUE}
+ \item{\code{.lowerExact}}{TRUE}
+ \item{\code{Symmetry}}{object of class \code{"EllipticalSymmetry"} about
center \code{loc}; used internally to avoid unnecessary calculations.}
}}
\section{Extends}{
@@ -55,8 +55,6 @@
\item{df}{\code{signature(x = "MVtDistribution")}: wrapped access method for
slot \code{scale} of slot \code{param}. }
-
-
}
}
\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
Modified: branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/MvtParameter-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -12,12 +12,12 @@
}
\section{Slots}{
\describe{
- \item{\code{loc}:}{ numeric; center / location of the distribution. }
- \item{\code{scale}:}{ matrix; the scale matrix; the number of rows of this
+ \item{\code{loc}}{ numeric; center / location of the distribution. }
+ \item{\code{scale}}{ matrix; the scale matrix; the number of rows of this
matrix must be the same as the length of \code{location}.}
- \item{\code{df}:}{ integer; the degrees of freedom. }
- \item{\code{ncp}:}{ positive real; the non-centrality parameter.}
- \item{\code{name}:}{ default name is
+ \item{\code{df}}{ integer; the degrees of freedom. }
+ \item{\code{ncp}}{ positive real; the non-centrality parameter.}
+ \item{\code{name}}{ default name is
\dQuote{parameter of a Elliptical distribution}. }
}
}
Modified: branches/distr-2.2/pkg/distrEllipse/man/SphericalDistribution-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrEllipse/man/SphericalDistribution-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrEllipse/man/SphericalDistribution-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -33,8 +33,6 @@
\alias{-,SphericalDistribution,numeric-method}
\alias{-,numeric,SphericalDistribution-method}
-
-
\title{Spherical distribution class}
\description{
Class \code{SphericalDistribution} implements general spherically symmetric
@@ -51,40 +49,39 @@
}
\section{Slots}{
\describe{
- \item{\code{img}:}{Object of class \code{"Reals"}. }
- \item{\code{param}:}{Object of class \code{"SphericalParameter"}. }
- \item{\code{r}:}{function with argument \code{n}; random number generator}
- \item{\code{d}:}{optional function; in case it exists:
+ \item{\code{img}}{Object of class \code{"Reals"}. }
+ \item{\code{param}}{Object of class \code{"SphericalParameter"}. }
+ \item{\code{r}}{function with argument \code{n}; random number generator}
+ \item{\code{d}}{optional function; in case it exists:
the density of the distribution}
- \item{\code{p}:}{optional function; in case it is non-null:
+ \item{\code{p}}{optional function; in case it is non-null:
the cdf of the distribution evaluated on rectangles, i.e. if a random
variable \code{X} is distributed according to an \code{object} of class
\code{"SphericalDistribution"},
for \code{q} a matrix of dimension \eqn{d \times n}{d x n} \code{p(object)(q)}
returns, for each of the \code{n} columns
\eqn{P(X_i\leq q_i,\;i=1,\ldots,d)}{P(X[i]<= q[i],\;i=1,\dots,d)}.}
- \item{\code{q}:}{optional function; in case it is non-null:
+ \item{\code{q}}{optional function; in case it is non-null:
the quantile of the distribution evaluated on rectangles, i.e. if a random
variable \code{X} is distributed according to an \code{object} of class
\code{"SphericalDistribution"},
for \code{p} a vector of length \eqn{n}, returns, for each of the
\code{n} components the infinimal number \eqn{q_j}{q[j]} such that
\eqn{P(X_i\leq q_j,\;i=1,\ldots,d)\ge p_j}{P(X[i]<= q[j],\;i=1,\dots,d)>= p[j]}.}
- \item{\code{radDistr}:}{an object of class \code{UnivariateDistribution} with positive
+ \item{\code{radDistr}}{an object of class \code{UnivariateDistribution} with positive
support, i.e. \code{p(radDistr)(0)==0}; the radial distribution. }
- \item{\code{.withArith}:}{logical: used internally to issue warnings as to
+ \item{\code{.withArith}}{logical: used internally to issue warnings as to
interpretation of arithmetics}
- \item{\code{.withSim}:}{logical: used internally to issue warnings as to
+ \item{\code{.withSim}}{logical: used internally to issue warnings as to
accuracy}
- \item{\code{.logExact}:}{logical: used internally to flag the case where
+ \item{\code{.logExact}}{logical: used internally to flag the case where
there are explicit formulae for the log version of density, cdf, and
quantile function}
- \item{\code{.lowerExact}:}{logical: used internally to flag the case where
+ \item{\code{.lowerExact}}{logical: used internally to flag the case where
there are explicit formulae for the lower tail version of cdf and quantile
function}
- \item{\code{Symmetry}:}{object of class \code{"SphericalSymmetry"} about
- center \code{loc};
- used internally to avoid unnecessary calculations.}
+ \item{\code{Symmetry}}{object of class \code{"SphericalSymmetry"} about
+ center \code{loc}; used internally to avoid unnecessary calculations.}
}
}
\section{Extends}{
@@ -133,30 +130,30 @@
\item{coerce}{\code{signature(from = "SphericalDistribution", to = "EllipticalDistribution")}:
create a \code{EllipticalDistribution} object from a spherically symmetric
distribution. }
- \item{\code{+}}{\code{signature(e1 = "SphericalDistribution", e2 = "numeric")}:{
+ \item{\code{+}}{\code{signature(e1 = "SphericalDistribution", e2 = "numeric")}:
affine linear transformation; exact.
- }}
- \item{\code{-}}{\code{signature(e1 = "SphericalDistribution", e2 = "numeric")}:{
+ }
+ \item{\code{-}}{\code{signature(e1 = "SphericalDistribution", e2 = "numeric")}:
affine linear transformation; exact.
- }}
- \item{\code{-}}{\code{signature(e1 = "SphericalDistribution", e2 = "missing")}:{
+ }
+ \item{\code{-}}{\code{signature(e1 = "SphericalDistribution", e2 = "missing")}:
affine linear transformation; exact.
- }}
- \item{\code{*}}{\code{signature(e1 = "SphericalDistribution", e2 = "numeric")}:{
+ }
+ \item{\code{*}}{\code{signature(e1 = "SphericalDistribution", e2 = "numeric")}:
affine linear transformation; exact.
- }}
- \item{\code{+}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:{
+ }
+ \item{\code{+}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:
affine linear transformation; exact.
- }}
- \item{\code{-}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:{
+ }
+ \item{\code{-}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:
affine linear transformation; exact.
- }}
- \item{\code{*}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:{
+ }
+ \item{\code{*}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:
affine linear transformation; exact.
- }}
- \item{\code{\%*\%}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:{
+ }
+ \item{\code{\%*\%}}{\code{signature(e1 = "numeric", e2 = "SphericalDistribution")}:
affine linear transformation; exact.
- }}
+ }
}
}
Modified: branches/distr-2.2/pkg/distrMod/man/BiasType-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/BiasType-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/BiasType-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -9,7 +9,7 @@
\section{Objects from the Class}{A virtual Class: No objects may be created from it.}
\section{Slots}{
\describe{
- \item{\code{name}:}{Object of class \code{"character"}.}
+ \item{\code{name}}{Object of class \code{"character"}.}
}
}
\section{Methods}{
Modified: branches/distr-2.2/pkg/distrMod/man/Confint-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/Confint-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/Confint-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -28,26 +28,26 @@
}
\section{Slots}{
\describe{
- \item{\code{type}:}{Object of class \code{"character"}:
+ \item{\code{type}}{Object of class \code{"character"}:
type of the confidence interval (asymptotic, bootstrap,\dots).
Can be of length \code{>2}. Then in printing, the first element
is printed in the gap '[...]' in 'an [...] confidence interval',
while the other elements are printed below.}
- \item{\code{confint}:}{Object of class \code{"array"}:
+ \item{\code{confint}}{Object of class \code{"array"}:
the confidence interval(s).}
- \item{\code{call.estimate}:}{Object of class \code{"call"}:
+ \item{\code{call.estimate}}{Object of class \code{"call"}:
the estimate(s) for which the confidence intervals are produced.}
- \item{\code{name.estimate}:}{Object of class \code{"character"}:
+ \item{\code{name.estimate}}{Object of class \code{"character"}:
the name of the estimate(s) for which the confidence intervals are produced.}
- \item{\code{samplesize.estimate}:}{Object of class \code{"numeric"}:
+ \item{\code{samplesize.estimate}}{Object of class \code{"numeric"}:
the sample size of the estimate(s) for which the confidence intervals are produced.}
- \item{\code{trafo.estimate}:}{Object of class \code{"matrix"}:
+ \item{\code{trafo.estimate}}{Object of class \code{"matrix"}:
the trafo/derivative matrix of the estimate(s) for which
the confidence intervals are produced.}
- \item{\code{nuisance.estimate}:}{Object of class \code{"OptionalNumeric"}:
+ \item{\code{nuisance.estimate}}{Object of class \code{"OptionalNumeric"}:
the nuisance parameter (if any) at which the confidence
intervals are produced.}
- \item{\code{fixed.estimate}:}{Object of class \code{"OptionalNumeric"}:
+ \item{\code{fixed.estimate}}{Object of class \code{"OptionalNumeric"}:
the fixed part of the parameter (if any) at which the confidence
intervals are produced.}
}
@@ -82,6 +82,7 @@
of the object; slots \code{nuisance.estimate} and
\code{fixed.estimate} are only shown if non-null,
and slot \code{trafo.estimate} only if different from a unit matrix.}
+
\item{print}{\code{signature(object = "Confint")}: just as \code{show},
but with additional arguments \code{digits}.}
}
Modified: branches/distr-2.2/pkg/distrMod/man/Estimate-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/Estimate-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/Estimate-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -38,28 +38,28 @@
}
\section{Slots}{
\describe{
- \item{\code{name}:}{Object of class \code{"character"}:
+ \item{\code{name}}{Object of class \code{"character"}:
name of the estimator. }
- \item{\code{estimate}:}{Object of class \code{"ANY"}:
+ \item{\code{estimate}}{Object of class \code{"ANY"}:
estimate.}
- \item{\code{estimate.call}:}{Object of class \code{"call"}:
+ \item{\code{estimate.call}}{Object of class \code{"call"}:
call by which estimate was produced.}
- \item{\code{Infos}:}{ object of class \code{"matrix"}
+ \item{\code{Infos}}{ object of class \code{"matrix"}
with two columns named \code{method} and \code{message}:
additional informations. }
- \item{\code{asvar}:}{ object of class \code{"OptionalNumericOrMatrix"}
+ \item{\code{asvar}}{ object of class \code{"OptionalNumericOrMatrix"}
which may contain the asymptotic (co)variance of the estimator. }
- \item{\code{samplesize}:}{ object of class \code{"numeric"} ---
+ \item{\code{samplesize}}{ object of class \code{"numeric"} ---
the samplesize at which the estimate was evaluated. }
- \item{\code{nuis.idx}:}{ object of class \code{"OptionalNumeric"}:
+ \item{\code{nuis.idx}}{ object of class \code{"OptionalNumeric"}:
indices of \code{estimate} belonging to the nuisance part. }
- \item{\code{fixed}:}{ object of class \code{"OptionalNumeric"}:
+ \item{\code{fixed}}{ object of class \code{"OptionalNumeric"}:
the fixed and known part of the parameter. }
- \item{\code{trafo}:}{ object of class \code{"list"}:
+ \item{\code{trafo}}{ object of class \code{"list"}:
a list with components \code{fct} and \code{mat} (see below). }
- \item{\code{untransformed.estimate}:}{Object of class \code{"ANY"}:
+ \item{\code{untransformed.estimate}}{Object of class \code{"ANY"}:
untransformed estimate. }
- \item{\code{untransformed.asvar}:}{ object of class \code{"OptionalNumericOrMatrix"}
+ \item{\code{untransformed.asvar}}{ object of class \code{"OptionalNumericOrMatrix"}
which may contain the asymptotic (co)variance of the untransformed
estimator. }
}
Modified: branches/distr-2.2/pkg/distrMod/man/EvenSymmetric-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/EvenSymmetric-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/EvenSymmetric-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -11,9 +11,9 @@
}
\section{Slots}{
\describe{
- \item{\code{type}:}{Object of class \code{"character"}:
+ \item{\code{type}}{Object of class \code{"character"}:
contains \dQuote{even function} }
- \item{\code{SymmCenter}:}{Object of class \code{"numeric"}:
+ \item{\code{SymmCenter}}{Object of class \code{"numeric"}:
center of symmetry }
}
}
Modified: branches/distr-2.2/pkg/distrMod/man/FunSymmList-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/FunSymmList-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/FunSymmList-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -11,7 +11,7 @@
}
\section{Slots}{
\describe{
- \item{\code{.Data}:}{ Object of class \code{"list"}. A list
+ \item{\code{.Data}}{ Object of class \code{"list"}. A list
of objects of class \code{"FunctionSymmetry"}. }
}
}
Modified: branches/distr-2.2/pkg/distrMod/man/FunctionSymmetry-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/FunctionSymmetry-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/FunctionSymmetry-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -8,9 +8,9 @@
\section{Objects from the Class}{A virtual Class: No objects may be created from it.}
\section{Slots}{
\describe{
- \item{\code{type}:}{Object of class \code{"character"}:
+ \item{\code{type}}{Object of class \code{"character"}:
discribes type of symmetry. }
- \item{\code{SymmCenter}:}{Object of class \code{"OptionalNumeric"}:
+ \item{\code{SymmCenter}}{Object of class \code{"OptionalNumeric"}:
center of symmetry. }
}
}
Modified: branches/distr-2.2/pkg/distrMod/man/L2GroupFamily-class.Rd
===================================================================
--- branches/distr-2.2/pkg/distrMod/man/L2GroupFamily-class.Rd 2009-08-20 13:57:36 UTC (rev 534)
+++ branches/distr-2.2/pkg/distrMod/man/L2GroupFamily-class.Rd 2009-08-20 13:57:59 UTC (rev 535)
@@ -16,44 +16,44 @@
}
\section{Slots}{
\describe{
- \item{\code{name}:}{[inherited from class \code{"ProbFamily"}]
+ \item{\code{name}}{[inherited from class \code{"ProbFamily"}]
object of class \code{"character"}:
name of the family. }
- \item{\code{distribution}:}{[inherited from class \code{"ProbFamily"}]
+ \item{\code{distribution}}{[inherited from class \code{"ProbFamily"}]
object of class \code{"Distribution"}:
member of the family. }
- \item{\code{distrSymm}:}{[inherited from class \code{"ProbFamily"}]
+ \item{\code{distrSymm}}{[inherited from class \code{"ProbFamily"}]
object of class \code{"DistributionSymmetry"}:
symmetry of \code{distribution}. }
- \item{\code{param}:}{[inherited from class \code{"ParamFamily"}]
+ \item{\code{param}}{[inherited from class \code{"ParamFamily"}]
object of class \code{"ParamFamParameter"}:
parameter of the family. }
- \item{\code{fam.call}:}{[inherited from class \code{"ParamFamily"}]
+ \item{\code{fam.call}}{[inherited from class \code{"ParamFamily"}]
object of class \code{"call"}:
call by which parametric family was produced.}
- \item{\code{makeOKPar}:}{[inherited from class \code{"ParamFamily"}]
+ \item{\code{makeOKPar}}{[inherited from class \code{"ParamFamily"}]
object of class \code{"function"}:
has argument \code{param} --- the (total) parameter,
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/distr -r 535
More information about the Distr-commits
mailing list