[Distr-commits] r1046 - in pkg/distrMod: man vignettes
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Tue Jun 16 09:32:15 CEST 2015
Author: ruckdeschel
Date: 2015-06-16 09:32:15 +0200 (Tue, 16 Jun 2015)
New Revision: 1046
Modified:
pkg/distrMod/man/0distrMod-package.Rd
pkg/distrMod/man/BetaFamily.Rd
pkg/distrMod/man/BiasType-class.Rd
pkg/distrMod/man/Confint-class.Rd
pkg/distrMod/man/Estimate-class.Rd
pkg/distrMod/man/Estimator.Rd
pkg/distrMod/man/InternalReturnClasses-class.Rd
pkg/distrMod/man/L2GroupFamily-class.Rd
pkg/distrMod/man/L2LocationFamily-class.Rd
pkg/distrMod/man/L2LocationFamily.Rd
pkg/distrMod/man/L2LocationScaleFamily-class.Rd
pkg/distrMod/man/L2LocationScaleFamily.Rd
pkg/distrMod/man/L2LocationUnknownScaleFamily.Rd
pkg/distrMod/man/L2ParamFamily-class.Rd
pkg/distrMod/man/L2ParamFamily.Rd
pkg/distrMod/man/L2ScaleFamily-class.Rd
pkg/distrMod/man/L2ScaleFamily.Rd
pkg/distrMod/man/L2ScaleUnknownLocationFamily.Rd
pkg/distrMod/man/MCEstimate-class.Rd
pkg/distrMod/man/MCEstimator.Rd
pkg/distrMod/man/MDEstimator.Rd
pkg/distrMod/man/MLEstimator.Rd
pkg/distrMod/man/NBinomFamily.Rd
pkg/distrMod/man/NormType-class.Rd
pkg/distrMod/man/NormType.Rd
pkg/distrMod/man/ParamFamParameter-class.Rd
pkg/distrMod/man/ParamFamParameter.Rd
pkg/distrMod/man/ParamFamily.Rd
pkg/distrMod/man/QFNorm.Rd
pkg/distrMod/man/QFnorm-class.Rd
pkg/distrMod/man/addAlphTrsp2col.Rd
pkg/distrMod/man/asRiskwithBias-class.Rd
pkg/distrMod/man/asSemivar-class.Rd
pkg/distrMod/man/asSemivar.Rd
pkg/distrMod/man/asymmetricBias-class.Rd
pkg/distrMod/man/asymmetricBias.Rd
pkg/distrMod/man/distrModMASK.Rd
pkg/distrMod/man/distrModOptions.Rd
pkg/distrMod/man/existsPIC.Rd
pkg/distrMod/man/internalClassUnions-class.Rd
pkg/distrMod/man/internalmleHelpers.Rd
pkg/distrMod/man/internals-qqplot.Rd
pkg/distrMod/man/internals.Rd
pkg/distrMod/man/isKerAinKerB.Rd
pkg/distrMod/man/meRes.Rd
pkg/distrMod/man/negativeBias.Rd
pkg/distrMod/man/norms.Rd
pkg/distrMod/man/onesidedBias-class.Rd
pkg/distrMod/man/positiveBias.Rd
pkg/distrMod/man/qqplot.Rd
pkg/distrMod/man/symmetricBias-class.Rd
pkg/distrMod/man/symmetricBias.Rd
pkg/distrMod/vignettes/distrMod.Rnw
Log:
Mail-Adresse aktualisiert
Modified: pkg/distrMod/man/0distrMod-package.Rd
===================================================================
--- pkg/distrMod/man/0distrMod-package.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/0distrMod-package.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -279,10 +279,10 @@
}
\author{
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de},\cr
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de},\cr
Matthias Kohl \email{Matthias.Kohl at stamats.de}\cr
-\emph{Maintainer:} Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}
+\emph{Maintainer:} Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}
}
\references{
Modified: pkg/distrMod/man/BetaFamily.Rd
===================================================================
--- pkg/distrMod/man/BetaFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/BetaFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -22,7 +22,7 @@
parameteric family are filled.
}
\value{Object of class \code{"L2ParamFamily"}}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ParamFamily-class}}, \code{\link[distr]{Beta-class}}}
\examples{
Modified: pkg/distrMod/man/BiasType-class.Rd
===================================================================
--- pkg/distrMod/man/BiasType-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/BiasType-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -29,7 +29,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{RiskType-class}}}
\examples{
Modified: pkg/distrMod/man/Confint-class.Rd
===================================================================
--- pkg/distrMod/man/Confint-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/Confint-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -127,7 +127,7 @@
has been borrowed from \code{confint.default} in package \pkg{stats}.}
%\references{}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{Estimator}}, \code{\link{confint}}, \code{\link{Estimate-class}},
\code{\link{trafo-methods}}}
Modified: pkg/distrMod/man/Estimate-class.Rd
===================================================================
--- pkg/distrMod/man/Estimate-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/Estimate-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -202,7 +202,7 @@
\eqn{\tau(\theta)=D\,\theta}{tau(theta)=D * theta}.\cr
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
\note{
The pretty-printing code for methods \code{show} and \code{print}
has been borrowed from \code{print.fitdistr} in package \pkg{MASS} by B.D. Ripley.
Modified: pkg/distrMod/man/Estimator.Rd
===================================================================
--- pkg/distrMod/man/Estimator.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/Estimator.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -1,60 +1,60 @@
-\name{Estimator}
-\alias{Estimator}
-
-\title{ Function to compute estimates }
-\description{
- The function \code{Estimator} provides a general way to compute
- estimates.
-}
-\usage{
-Estimator(x, estimator, name, Infos, asvar = NULL, nuis.idx,
- trafo = NULL, fixed = NULL, asvar.fct, na.rm = TRUE, ...,
- ParamFamily = NULL, .withEvalAsVar = TRUE)
-}
-\arguments{
- \item{x}{ (empirical) data }
- \item{estimator}{ function: estimator to be evaluated on \code{x}. }
- \item{name}{ optional name for estimator. }
- \item{Infos}{ character: optional informations about estimator }
- \item{asvar}{ optionally the asymptotic (co)variance of the estimator }
- \item{nuis.idx}{ optionally the indices of the estimate belonging
- to nuisance parameter}
- \item{fixed}{ optionally (numeric) the fixed part of the parameter}
- \item{trafo}{ an object of class \code{MatrixorFunction} -- a transformation
- for the main parameter}
- \item{asvar.fct}{optionally: a function to determine the corresponding
- asymptotic variance; if given, \code{asvar.fct} takes arguments
- \code{L2Fam}(the parametric model as object of class \code{L2ParamFamily})
- and \code{param} (the parameter value as object of class
- \code{ParamFamParameter}); arguments are called by name; \code{asvar.fct}
- may also process further arguments passed through the \code{\dots} argument. }
- \item{na.rm}{logical: if \code{TRUE}, the estimator is evaluated at \code{complete.cases(x)}.}
- \item{\dots}{ further arguments to \code{estimator}.}
- \item{ParamFamily}{an optional object of class \code{ParamFamily}. Passed on
- to \code{asvar.fct} to compute asymptotic variances.}
- \item{.withEvalAsVar}{logical: shall slot \code{asVar} be evaluated
- (if \code{asvar.fct} is given) or
- just the call be returned?}
-
-}
-\details{
- The argument \code{criterion} has to be a function with arguments the
- empirical data as well as an object of class \code{"Distribution"}
- and possibly \code{\dots}.
-}
-\value{
- An object of S4-class \code{"Estimate"}.
-}
-%\references{ }
-\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
-%\note{}
-\seealso{\code{\link{Estimate-class}} }
-\examples{
-x <- rnorm(100)
-Estimator(x, estimator = mean, name = "mean")
-
-X <- matrix(rnorm(1000), nrow = 10)
-Estimator(X, estimator = rowMeans, name = "mean")
-}
-\keyword{univar}
+\name{Estimator}
+\alias{Estimator}
+
+\title{ Function to compute estimates }
+\description{
+ The function \code{Estimator} provides a general way to compute
+ estimates.
+}
+\usage{
+Estimator(x, estimator, name, Infos, asvar = NULL, nuis.idx,
+ trafo = NULL, fixed = NULL, asvar.fct, na.rm = TRUE, ...,
+ ParamFamily = NULL, .withEvalAsVar = TRUE)
+}
+\arguments{
+ \item{x}{ (empirical) data }
+ \item{estimator}{ function: estimator to be evaluated on \code{x}. }
+ \item{name}{ optional name for estimator. }
+ \item{Infos}{ character: optional informations about estimator }
+ \item{asvar}{ optionally the asymptotic (co)variance of the estimator }
+ \item{nuis.idx}{ optionally the indices of the estimate belonging
+ to nuisance parameter}
+ \item{fixed}{ optionally (numeric) the fixed part of the parameter}
+ \item{trafo}{ an object of class \code{MatrixorFunction} -- a transformation
+ for the main parameter}
+ \item{asvar.fct}{optionally: a function to determine the corresponding
+ asymptotic variance; if given, \code{asvar.fct} takes arguments
+ \code{L2Fam}(the parametric model as object of class \code{L2ParamFamily})
+ and \code{param} (the parameter value as object of class
+ \code{ParamFamParameter}); arguments are called by name; \code{asvar.fct}
+ may also process further arguments passed through the \code{\dots} argument. }
+ \item{na.rm}{logical: if \code{TRUE}, the estimator is evaluated at \code{complete.cases(x)}.}
+ \item{\dots}{ further arguments to \code{estimator}.}
+ \item{ParamFamily}{an optional object of class \code{ParamFamily}. Passed on
+ to \code{asvar.fct} to compute asymptotic variances.}
+ \item{.withEvalAsVar}{logical: shall slot \code{asVar} be evaluated
+ (if \code{asvar.fct} is given) or
+ just the call be returned?}
+
+}
+\details{
+ The argument \code{criterion} has to be a function with arguments the
+ empirical data as well as an object of class \code{"Distribution"}
+ and possibly \code{\dots}.
+}
+\value{
+ An object of S4-class \code{"Estimate"}.
+}
+%\references{ }
+\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
+%\note{}
+\seealso{\code{\link{Estimate-class}} }
+\examples{
+x <- rnorm(100)
+Estimator(x, estimator = mean, name = "mean")
+
+X <- matrix(rnorm(1000), nrow = 10)
+Estimator(X, estimator = rowMeans, name = "mean")
+}
+\keyword{univar}
Modified: pkg/distrMod/man/InternalReturnClasses-class.Rd
===================================================================
--- pkg/distrMod/man/InternalReturnClasses-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/InternalReturnClasses-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -162,7 +162,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\concept{parametric family}
\keyword{classes}
Modified: pkg/distrMod/man/L2GroupFamily-class.Rd
===================================================================
--- pkg/distrMod/man/L2GroupFamily-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2GroupFamily-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -103,7 +103,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ParamFamily-class}}, \code{\link{ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2LocationFamily-class.Rd
===================================================================
--- pkg/distrMod/man/L2LocationFamily-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2LocationFamily-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -103,7 +103,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2LocationFamily}}, \code{\link{ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2LocationFamily.Rd
===================================================================
--- pkg/distrMod/man/L2LocationFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2LocationFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -67,7 +67,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2LocationFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2LocationScaleFamily-class.Rd
===================================================================
--- pkg/distrMod/man/L2LocationScaleFamily-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2LocationScaleFamily-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -102,7 +102,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2LocationScaleFamily}}, \code{\link{ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2LocationScaleFamily.Rd
===================================================================
--- pkg/distrMod/man/L2LocationScaleFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2LocationScaleFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -74,7 +74,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2LocationScaleFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2LocationUnknownScaleFamily.Rd
===================================================================
--- pkg/distrMod/man/L2LocationUnknownScaleFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2LocationUnknownScaleFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -73,7 +73,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2LocationScaleFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2ParamFamily-class.Rd
===================================================================
--- pkg/distrMod/man/L2ParamFamily-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2ParamFamily-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -217,7 +217,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ParamFamily}}, \code{\link{ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2ParamFamily.Rd
===================================================================
--- pkg/distrMod/man/L2ParamFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2ParamFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -99,7 +99,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2ScaleFamily-class.Rd
===================================================================
--- pkg/distrMod/man/L2ScaleFamily-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2ScaleFamily-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -101,7 +101,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ScaleFamily}}, \code{\link{ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2ScaleFamily.Rd
===================================================================
--- pkg/distrMod/man/L2ScaleFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2ScaleFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -72,7 +72,7 @@
Bayreuth: Dissertation.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ScaleFamily-class}}}
\examples{
Modified: pkg/distrMod/man/L2ScaleUnknownLocationFamily.Rd
===================================================================
--- pkg/distrMod/man/L2ScaleUnknownLocationFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/L2ScaleUnknownLocationFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -74,7 +74,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2LocationScaleFamily-class}}}
\examples{
Modified: pkg/distrMod/man/MCEstimate-class.Rd
===================================================================
--- pkg/distrMod/man/MCEstimate-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/MCEstimate-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -1,131 +1,131 @@
-\name{MCEstimate-class}
-\docType{class}
-\alias{MCEstimate-class}
-\alias{criterion}
-\alias{criterion,MCEstimate-method}
-\alias{criterion.fct}
-\alias{criterion.fct,MCEstimate-method}
-\alias{startPar,MCEstimate-method}
-\alias{method}
-\alias{method,MCEstimate-method}
-\alias{optimwarn}
-\alias{optimwarn,MCEstimate-method}
-\alias{criterion<-}
-\alias{criterion<-,MCEstimate-method}
-\alias{coerce,MCEstimate,mle-method}
-\alias{show,MCEstimate-method}
-\alias{profile,MCEstimate-method}
-
-\title{MCEstimate-class.}
-\description{Class of minimum criterion estimates.}
-\section{Objects from the Class}{
- Objects can be created by calls of the form \code{new("MCEstimate", ...)}.
- More frequently they are created via the generating functions
- \code{MCEstimator}, \code{MDEstimator} or \code{MLEstimator}.
-}
-\section{Slots}{
- \describe{
- \item{\code{name}}{Object of class \code{"character"}:
- name of the estimator. }
- \item{\code{estimate}}{Object of class \code{"ANY"}:
- estimate.}
- \item{\code{estimate.call}}{Object of class \code{"call"}:
- call by which estimate was produced.}
- \item{\code{criterion}}{Object of class \code{"numeric"}:
- minimum value of the considered criterion.}
- \item{\code{criterion.fct}}{Object of class \code{"function"}:
- the considered criterion function; used for compatibility with class
- \code{"mle"} from package \pkg{stats4}; should be a function
- returning the criterion; i.e. a numeric of length 1 and should have
- as arguments all named components of argument
- \code{untransformed.estimate}}
- \item{\code{method}}{Object of class \code{"character"}:
- the method by which the estimate was calculated, i.e.;
- \code{"optim"}, \code{"optimize"}, or \code{"explicit calculation"};
- used for compatibility with class \code{"mle"} from package
- \pkg{stats4}, could be any character value.}
- \item{\code{Infos}}{ object of class \code{"matrix"}
- with two columns named \code{method} and \code{message}:
- additional informations. }
- \item{\code{optimwarn}}{ object of class \code{"character"}
- warnings issued during optimization. }
- \item{\code{startPar}}{ --- object of class \code{"ANY"}; filled either
- with \code{NULL} (no starting value used) or with \code{"numeric"}
- --- the value of the starting parameter. }
- \item{\code{asvar}}{ object of class \code{"OptionalMatrix"}
- which may contain the asymptotic (co)variance of the estimator. }
- \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"}:
- indices of \code{estimate} belonging to the nuisance part}
- \item{\code{fixed}}{ object of class \code{"OptionalNumeric"}:
- the fixed and known part of the parameter. }
- \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"}:
- untransformed estimate.}
- \item{\code{untransformed.asvar}}{ object of class \code{"OptionalNumericOrMatrix"}
- which may contain the asymptotic (co)variance of the untransformed
- estimator. }
- \item{\code{completecases}}{ object of class \code{"logical"} ---
- complete cases at which the estimate was evaluated. }
- \item{\code{startPar}}{ object of class \code{"ANY"}; usually filled with
- argument \code{startPar} of generating function \code{MCEstimator},
- \code{MLEstimator}, \code{MDEstimator}.}
- }
-}
-\section{Extends}{
-Class \code{"Estimate"}, directly.
-}
-\section{Methods}{
- \describe{
- \item{criterion}{\code{signature(object = "MCEstimate")}:
- accessor function for slot \code{criterion}. }
-
- \item{criterion<-}{\code{signature(object = "MCEstimate")}:
- replacement function for slot \code{criterion}. }
-
- \item{optimwarn}{\code{signature(object = "MCEstimate")}:
- accessor function for slot \code{optimwarn}. }
-
- \item{startPar}{\code{signature(object = "MCEstimate")}:
- accessor function for slot \code{startPar}. }
-
- \item{criterion.fct}{\code{signature(object = "MCEstimate")}:
- accessor function for slot \code{criterion.fct}. }
-
- \item{show}{\code{signature(object = "Estimate")}}
-
- \item{coerce}{\code{signature(from = "MCEstimate", to = "mle")}:
- create a \code{"mle"} object from a \code{"MCEstimate"} object}
-
- \item{profile}{\code{signature(fitted = "MCEstimate")}:
- coerces \code{fitted} to class \code{"mle"} and then calls
- the corresponding \code{\link[stats4:profile-methods]{profile}}-method
- from package \pkg{stats4}; for details we confer to the corresponding
- man page.}
- }
-}
-
-%\references{}
-\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
-%\note{}
-\seealso{\code{\link{Estimate-class}}, \code{\link{MCEstimator}},
- \code{\link{MDEstimator}}, \code{\link{MLEstimator}}}
-\examples{
-## (empirical) Data
-x <- rgamma(50, scale = 0.5, shape = 3)
-
-## parametric family of probability measures
-G <- GammaFamily(scale = 1, shape = 2)
-
-MDEstimator(x, G)
-(m <- MLEstimator(x, G))
-m.mle <- as(m,"mle")
-par(mfrow=c(1,2))
-profileM <- profile(m)
-## plot-profile throws an error
-}
-\concept{estimate}
-\keyword{classes}
+\name{MCEstimate-class}
+\docType{class}
+\alias{MCEstimate-class}
+\alias{criterion}
+\alias{criterion,MCEstimate-method}
+\alias{criterion.fct}
+\alias{criterion.fct,MCEstimate-method}
+\alias{startPar,MCEstimate-method}
+\alias{method}
+\alias{method,MCEstimate-method}
+\alias{optimwarn}
+\alias{optimwarn,MCEstimate-method}
+\alias{criterion<-}
+\alias{criterion<-,MCEstimate-method}
+\alias{coerce,MCEstimate,mle-method}
+\alias{show,MCEstimate-method}
+\alias{profile,MCEstimate-method}
+
+\title{MCEstimate-class.}
+\description{Class of minimum criterion estimates.}
+\section{Objects from the Class}{
+ Objects can be created by calls of the form \code{new("MCEstimate", ...)}.
+ More frequently they are created via the generating functions
+ \code{MCEstimator}, \code{MDEstimator} or \code{MLEstimator}.
+}
+\section{Slots}{
+ \describe{
+ \item{\code{name}}{Object of class \code{"character"}:
+ name of the estimator. }
+ \item{\code{estimate}}{Object of class \code{"ANY"}:
+ estimate.}
+ \item{\code{estimate.call}}{Object of class \code{"call"}:
+ call by which estimate was produced.}
+ \item{\code{criterion}}{Object of class \code{"numeric"}:
+ minimum value of the considered criterion.}
+ \item{\code{criterion.fct}}{Object of class \code{"function"}:
+ the considered criterion function; used for compatibility with class
+ \code{"mle"} from package \pkg{stats4}; should be a function
+ returning the criterion; i.e. a numeric of length 1 and should have
+ as arguments all named components of argument
+ \code{untransformed.estimate}}
+ \item{\code{method}}{Object of class \code{"character"}:
+ the method by which the estimate was calculated, i.e.;
+ \code{"optim"}, \code{"optimize"}, or \code{"explicit calculation"};
+ used for compatibility with class \code{"mle"} from package
+ \pkg{stats4}, could be any character value.}
+ \item{\code{Infos}}{ object of class \code{"matrix"}
+ with two columns named \code{method} and \code{message}:
+ additional informations. }
+ \item{\code{optimwarn}}{ object of class \code{"character"}
+ warnings issued during optimization. }
+ \item{\code{startPar}}{ --- object of class \code{"ANY"}; filled either
+ with \code{NULL} (no starting value used) or with \code{"numeric"}
+ --- the value of the starting parameter. }
+ \item{\code{asvar}}{ object of class \code{"OptionalMatrix"}
+ which may contain the asymptotic (co)variance of the estimator. }
+ \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"}:
+ indices of \code{estimate} belonging to the nuisance part}
+ \item{\code{fixed}}{ object of class \code{"OptionalNumeric"}:
+ the fixed and known part of the parameter. }
+ \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"}:
+ untransformed estimate.}
+ \item{\code{untransformed.asvar}}{ object of class \code{"OptionalNumericOrMatrix"}
+ which may contain the asymptotic (co)variance of the untransformed
+ estimator. }
+ \item{\code{completecases}}{ object of class \code{"logical"} ---
+ complete cases at which the estimate was evaluated. }
+ \item{\code{startPar}}{ object of class \code{"ANY"}; usually filled with
+ argument \code{startPar} of generating function \code{MCEstimator},
+ \code{MLEstimator}, \code{MDEstimator}.}
+ }
+}
+\section{Extends}{
+Class \code{"Estimate"}, directly.
+}
+\section{Methods}{
+ \describe{
+ \item{criterion}{\code{signature(object = "MCEstimate")}:
+ accessor function for slot \code{criterion}. }
+
+ \item{criterion<-}{\code{signature(object = "MCEstimate")}:
+ replacement function for slot \code{criterion}. }
+
+ \item{optimwarn}{\code{signature(object = "MCEstimate")}:
+ accessor function for slot \code{optimwarn}. }
+
+ \item{startPar}{\code{signature(object = "MCEstimate")}:
+ accessor function for slot \code{startPar}. }
+
+ \item{criterion.fct}{\code{signature(object = "MCEstimate")}:
+ accessor function for slot \code{criterion.fct}. }
+
+ \item{show}{\code{signature(object = "Estimate")}}
+
+ \item{coerce}{\code{signature(from = "MCEstimate", to = "mle")}:
+ create a \code{"mle"} object from a \code{"MCEstimate"} object}
+
+ \item{profile}{\code{signature(fitted = "MCEstimate")}:
+ coerces \code{fitted} to class \code{"mle"} and then calls
+ the corresponding \code{\link[stats4:profile-methods]{profile}}-method
+ from package \pkg{stats4}; for details we confer to the corresponding
+ man page.}
+ }
+}
+
+%\references{}
+\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
+%\note{}
+\seealso{\code{\link{Estimate-class}}, \code{\link{MCEstimator}},
+ \code{\link{MDEstimator}}, \code{\link{MLEstimator}}}
+\examples{
+## (empirical) Data
+x <- rgamma(50, scale = 0.5, shape = 3)
+
+## parametric family of probability measures
+G <- GammaFamily(scale = 1, shape = 2)
+
+MDEstimator(x, G)
+(m <- MLEstimator(x, G))
+m.mle <- as(m,"mle")
+par(mfrow=c(1,2))
+profileM <- profile(m)
+## plot-profile throws an error
+}
+\concept{estimate}
+\keyword{classes}
Modified: pkg/distrMod/man/MCEstimator.Rd
===================================================================
--- pkg/distrMod/man/MCEstimator.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/MCEstimator.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -63,7 +63,7 @@
computing the criterion differently for different parameter values.}
%\references{ }
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
- Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+ Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{ParamFamily-class}}, \code{\link{ParamFamily}},
\code{\link{MCEstimate-class}} }
Modified: pkg/distrMod/man/MDEstimator.Rd
===================================================================
--- pkg/distrMod/man/MDEstimator.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/MDEstimator.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -70,7 +70,7 @@
Rieder, H. (1994) \emph{Robust Asymptotic Statistics}. New York: Springer.
}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
- Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+ Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{ParamFamily-class}}, \code{\link{ParamFamily}},
\code{\link{MCEstimator}}, \code{\link{MCEstimate-class}},
Modified: pkg/distrMod/man/MLEstimator.Rd
===================================================================
--- pkg/distrMod/man/MLEstimator.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/MLEstimator.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -49,7 +49,7 @@
}
%\references{ }
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
- Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+ Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{ParamFamily-class}}, \code{\link{ParamFamily}},
\code{\link{MCEstimator}}, \code{\link{MCEstimate-class}},
Modified: pkg/distrMod/man/NBinomFamily.Rd
===================================================================
--- pkg/distrMod/man/NBinomFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/NBinomFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -41,7 +41,7 @@
R Package distrMod: S4 Classes and Methods for
Probability Models. To appear in Journal of Statistical Software.
}
-\author{Peter Ruckdeschel \email{peter.ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{L2ParamFamily-class}}, \code{\link[distr]{Nbinom-class}}}
\examples{
Modified: pkg/distrMod/man/NormType-class.Rd
===================================================================
--- pkg/distrMod/man/NormType-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/NormType-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -36,7 +36,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{BiasType-class}}}
\examples{
Modified: pkg/distrMod/man/NormType.Rd
===================================================================
--- pkg/distrMod/man/NormType.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/NormType.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -18,7 +18,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{NormType-class}}}
\examples{
Modified: pkg/distrMod/man/ParamFamParameter-class.Rd
===================================================================
--- pkg/distrMod/man/ParamFamParameter-class.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/ParamFamParameter-class.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -132,7 +132,7 @@
}
%\references{}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link[distr]{Parameter-class}}}
\examples{
Modified: pkg/distrMod/man/ParamFamParameter.Rd
===================================================================
--- pkg/distrMod/man/ParamFamParameter.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/ParamFamParameter.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -36,7 +36,7 @@
\code{.returnClsName})}
%\references{}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{ParamFamParameter-class}}}
\examples{
Modified: pkg/distrMod/man/ParamFamily.Rd
===================================================================
--- pkg/distrMod/man/ParamFamily.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/ParamFamily.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -57,7 +57,7 @@
\value{Object of class \code{"ParamFamily"}}
%\references{}
\author{Matthias Kohl \email{Matthias.Kohl at stamats.de},\cr
-Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{ParamFamily-class}}}
\examples{
Modified: pkg/distrMod/man/QFNorm.Rd
===================================================================
--- pkg/distrMod/man/QFNorm.Rd 2015-06-16 07:31:40 UTC (rev 1045)
+++ pkg/distrMod/man/QFNorm.Rd 2015-06-16 07:32:15 UTC (rev 1046)
@@ -20,7 +20,7 @@
Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
Bayreuth: Dissertation.
}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
%\note{}
\seealso{\code{\link{QFNorm-class}}}
\examples{
Modified: pkg/distrMod/man/QFnorm-class.Rd
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/distr -r 1046
More information about the Distr-commits
mailing list