[Robast-commits] r988 - branches/robast-1.1/pkg/RobExtremes/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Thu Jul 19 13:39:26 CEST 2018
Author: ruckdeschel
Date: 2018-07-19 13:39:26 +0200 (Thu, 19 Jul 2018)
New Revision: 988
Added:
branches/robast-1.1/pkg/RobExtremes/man/internalEstimatorReturnClasses-class.Rd
branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyClasses-class.Rd
branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyReturnClasses-class.Rd
Removed:
branches/robast-1.1/pkg/RobExtremes/man/InternalReturnClasses-class.Rd
Modified:
branches/robast-1.1/pkg/RobExtremes/man/Var.Rd
branches/robast-1.1/pkg/RobExtremes/man/internal-methods.Rd
Log:
[RobExtremes] branch 1.1 suppose R CMD check does not like usage section in internal-methods.Rd, so commented it out; new Rd files for now exported (formerly internal) intermediate classes; added timings for Sn
Deleted: branches/robast-1.1/pkg/RobExtremes/man/InternalReturnClasses-class.Rd
===================================================================
--- branches/robast-1.1/pkg/RobExtremes/man/InternalReturnClasses-class.Rd 2018-07-19 11:36:31 UTC (rev 987)
+++ branches/robast-1.1/pkg/RobExtremes/man/InternalReturnClasses-class.Rd 2018-07-19 11:39:26 UTC (rev 988)
@@ -1,45 +0,0 @@
-\name{InternalReturnClasses-class}
-\docType{class}
-\alias{InternalReturnClasses-class}
-\alias{GumbelLocationFamily-class}
-\alias{ParetoFamily-class}
-\alias{GEVFamily-class}
-\alias{GEVFamilyMuUnknown-class}
-\alias{GParetoFamily-class}
-\alias{WeibullFamily-class}
-
-\title{Internal return classes for generating functions}
-\description{internal return classes for generating functions 'L2ParamFamily' and
-'L2LocationFamily' (and friends); used for particular method dispatch only}
-
-\section{Described classes}{
-In this file we describe classes \code{GParetoFamily}, \code{GEVFamily},
-\code{GEVFamilyMuUnknown}, \code{WeibullFamily} all ``extending''
-(no new slots!) class union
-\code{"L2LocationScaleShapeUnion"} and \code{ParetoFamily} ``extending''
- (no new slots!) class \code{L2ParamFamily}.
-}
-\section{Objects from these classes}{
- Objects are only generated internally by the mentioned generating functions.
-}
-
-\section{Methods}{
- not yet done...
-}
-\seealso{\code{\link[methods:BasicClasses]{numeric-class}},
-\code{\link{L2ParamFamily-class}},
-\code{\link{L2ScaleShapeUnion-class}},
-}
-
-\references{
- Rieder, H. (1994) \emph{Robust Asymptotic Statistics}. New York: Springer.
-
- Kohl, M. (2005) \emph{Numerical Contributions to the Asymptotic Theory of Robustness}.
- Bayreuth: Dissertation.
-}
-\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
-%\note{}
-\concept{parametric family}
-\keyword{classes}
-\keyword{models}
-\keyword{internal}
Modified: branches/robast-1.1/pkg/RobExtremes/man/Var.Rd
===================================================================
--- branches/robast-1.1/pkg/RobExtremes/man/Var.Rd 2018-07-19 11:36:31 UTC (rev 987)
+++ branches/robast-1.1/pkg/RobExtremes/man/Var.Rd 2018-07-19 11:39:26 UTC (rev 988)
@@ -39,7 +39,6 @@
\alias{Sn,Gammad-method}
\alias{Sn,Weibull-method}
\alias{Sn,GEV-method}
-\alias{Sn,GEVU-method}
\alias{Sn,DiscreteDistribution-method}
\alias{Qn}
\alias{Qn-methods}
@@ -94,7 +93,6 @@
\S4method{Sn}{AffLinDistribution}(x, ...)
\S4method{Sn}{Norm}(x, ...)
\S4method{Sn}{GPareto}(x, ...)
-\S4method{Sn}{GEVU}(x, ...)
\S4method{Sn}{GEV}(x, ...)
\S4method{Sn}{Gammad}(x, ...)
\S4method{Sn}{Weibull}(x, ...)
@@ -224,8 +222,8 @@
IQR(G)
## note the timing
-Sn(GPareto(shape=0.5,scale=2))
-Sn(as(GPareto(shape=0.5,scale=2),"AbscontDistribution"))
+system.time(print(Sn(GPareto(shape=0.5,scale=2))))
+system.time(print(Sn(as(GPareto(shape=0.5,scale=2),"AbscontDistribution"))))
}
\seealso{\code{\link[distrEx]{Var}},\cr
Modified: branches/robast-1.1/pkg/RobExtremes/man/internal-methods.Rd
===================================================================
--- branches/robast-1.1/pkg/RobExtremes/man/internal-methods.Rd 2018-07-19 11:36:31 UTC (rev 987)
+++ branches/robast-1.1/pkg/RobExtremes/man/internal-methods.Rd 2018-07-19 11:39:26 UTC (rev 988)
@@ -16,21 +16,20 @@
\alias{.checkEstClassForParamFamily,GEVFamilyMuUnknown,kStepEstimate-method}
\title{ Methods for Function .checkEstClassForParamFamily in Package `RobExtremes' }
\description{.checkEstClassForParamFamily-methods}
-\usage{
-.checkEstClassForParamFamily(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GParetoFamily,Estimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GParetoFamily,MCEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GParetoFamily,LDEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GParetoFamily,kStepEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamily,Estimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamily,LDEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamily,MCEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamily,kStepEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,Estimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,LDEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,MCEstimate}(PFam, estimator)
-\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,kStepEstimate}(PFam, estimator)
-}
+%\usage{.checkEstClassForParamFamily(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GParetoFamily,Estimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GParetoFamily,MCEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GParetoFamily,LDEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GParetoFamily,kStepEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamily,Estimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamily,LDEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamily,MCEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamily,kStepEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,Estimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,LDEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,MCEstimate}(PFam, estimator)
+%\S4method{.checkEstClassForParamFamily}{GEVFamilyMuUnknown,kStepEstimate}(PFam, estimator)
+%}
\arguments{
\item{PFam}{a parametric family.}
\item{estimator}{an estimator. }
@@ -41,18 +40,30 @@
}
\value{
-The \code{GParetoFamily,Estimate}-method returns the estimator cast to \code{GPDEstimate},
-the \code{GParetoFamily,LDEstimate}-method to \code{GPDLDEstimate},
-the \code{GParetoFamily,MCEstimate}-method to \code{GPDMCEstimate},
-the \code{GParetoFamily,kStepEstimate}-method to \code{GPDkStepstimate},
-the \code{GEVFamily,Estimate}-method to \code{GEVEstimate},
-the \code{GEVFamily,LDEstimate}-method to \code{GEVLDEstimate},
-the \code{GEVFamily,MCEstimate}-method to \code{GEVMCEstimate},
-the \code{GEVFamily,kStepEstimate}-method to \code{GEVkStepstimate}.
-the \code{GEVFamilyMuUnknown,Estimate}-method to \code{GEVEstimate},
-the \code{GEVFamilyMuUnknown,LDEstimate}-method to \code{GEVLDEstimate},
-the \code{GEVFamilyMuUnknown,MCEstimate}-method to \code{GEVMCEstimate},
-the \code{GEVFamilyMuUnknown,kStepEstimate}-method to \code{GEVkStepstimate}.
+The \code{GParetoFamily,Estimate}-method returns the estimator cast to
+S4 class \code{GPDEstimate},
+the \code{GParetoFamily,LDEstimate}-method cast to
+S4 class \code{GPDLDEstimate},
+the \code{GParetoFamily,MCEstimate}-method cast to
+S4 class \code{GPDMCEstimate},
+the \code{GParetoFamily,kStepEstimate}-method cast to
+S4 class \code{GPDkStepstimate},
+the \code{GEVFamily,Estimate}-method cast to
+S4 class \code{GEVEstimate},
+the \code{GEVFamily,LDEstimate}-method cast to
+S4 class \code{GEVLDEstimate},
+the \code{GEVFamily,MCEstimate}-method cast to
+S4 class \code{GEVMCEstimate},
+the \code{GEVFamily,kStepEstimate}-method cast to
+S4 class \code{GEVkStepstimate}.
+the \code{GEVFamilyMuUnknown,Estimate}-method cast to
+S4 class \code{GEVEstimate},
+the \code{GEVFamilyMuUnknown,LDEstimate}-method cast to
+S4 class \code{GEVLDEstimate},
+the \code{GEVFamilyMuUnknown,MCEstimate}-method cast to
+S4 class \code{GEVMCEstimate},
+the \code{GEVFamilyMuUnknown,kStepEstimate}-method cast to
+S4 class \code{GEVkStepstimate}.
}
\author{
Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}
Added: branches/robast-1.1/pkg/RobExtremes/man/internalEstimatorReturnClasses-class.Rd
===================================================================
--- branches/robast-1.1/pkg/RobExtremes/man/internalEstimatorReturnClasses-class.Rd (rev 0)
+++ branches/robast-1.1/pkg/RobExtremes/man/internalEstimatorReturnClasses-class.Rd 2018-07-19 11:39:26 UTC (rev 988)
@@ -0,0 +1,55 @@
+\name{InternalEstimatorReturnClasses}
+\docType{class}
+\alias{InternalEstimatorReturnClasses-class}
+\alias{GPDEstimate-class}
+\alias{GEVEstimate-class}
+\alias{GPDMCEstimate-class}
+\alias{GEVMCEstimate-class}
+\alias{GPDLDEstimate-class}
+\alias{GEVLDEstimate-class}
+\alias{GPDkStepEstimate-class}
+\alias{GEVkStepEstimate-class}
+\title{Internal Estimator Return Classes in 'RobExtremes'}
+\description{S4 classes for return values of estimators
+in package \pkg{RobExtremes} defined for internal
+ purposes.}
+
+ \section{Described classes}{
+The S4 classes described here are \code{GPDEstimate}, \code{GEVEstimate},
+ \code{GPDMCEstimate}, \code{GEVMCEstimate},
+ \code{GPDLDEstimate}, \code{GEVLDEstimate},
+ \code{GPDkStepEstimate}, \code{GEVkStepEstimate}.}
+}
+\section{Objects from the Class}{These classes are used internally
+to provide specific S4 methods for different estimators later on;
+thus, there are no generating functions.}
+ \section{Slots}{
+ All slots are inherited from parent classes.
+}
+\section{Extends}{
+Classes \code{GPDEstimate}, \code{GEVEstimate} extend class \code{Estimate},
+directly.\cr
+Class \code{GPDMCEstimate} extends classes \code{GPDEstimate},
+\code{MCEstimate}, directly.\cr
+Class \code{GEVMCEstimate} extends classes \code{GEVEstimate},
+\code{MCEstimate}, directly.\cr
+Class \code{GPDLDEstimate} extends classes \code{GPDEstimate},
+\code{LDEstimate}, directly.\cr
+Class \code{GEVLDEstimate} extends classes \code{GEVEstimate},
+\code{LDEstimate}, directly.\cr
+Class \code{GPDkStepEstimate} extends classes \code{GPDEstimate},
+\code{kStepEstimate}, directly.\cr
+Class \code{GEVkStepEstimate} extends classes \code{GEVEstimate},
+\code{kStepEstimate}, directly.\cr
+}
+%\references{}
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
+%\note{}
+\seealso{\code{\link[distrMod]{Estimate-class}},
+\code{\link[distrMod]{MCEstimate-class}},
+\code{\link[distrMod]{kStepEstimate-class}},
+\code{\link{LDEstimate-class}}}
+\concept{GPD distribution}
+\concept{GEV distribution}
+\concept{S4 parameter class}
+\keyword{models}
Added: branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyClasses-class.Rd
===================================================================
--- branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyClasses-class.Rd (rev 0)
+++ branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyClasses-class.Rd 2018-07-19 11:39:26 UTC (rev 988)
@@ -0,0 +1,67 @@
+\name{InternalProbFamilyClasses-class}
+\docType{class}
+\alias{InternalProbFamilyClasses-class}
+\alias{L2LocScaleShapeUnion-class}
+\alias{ParamWithLocAndScaleAndShapeFamParameter-class}
+\alias{locscaleshapename,L2LocScaleShapeUnion-method}
+\alias{locscalename,L2LocScaleShapeUnion-method}
+\alias{scaleshapename,L2LocScaleShapeUnion-method}
+\alias{locationname,L2LocScaleShapeUnion-method}
+\alias{scalename,L2LocScaleShapeUnion-method}
+\alias{shapename,L2LocScaleShapeUnion-method}
+\alias{locscaleshapename<-,L2LocScaleShapeUnion-method}
+\title{Internal Classes for Method Dispatch in 'ProbFamliy' Classes}
+\description{Internal S4 classes for method dispatch in 'L2ParamFamily' and
+'L2LocationFamily' (and friends) and in the respective parameter classes.}
+
+\section{Described classes}{
+In this file we describe classes \code{L2LocScaleShapeUnion} and
+\code{ParamWithLocAndScaleAndShapeFamParameter}.\cr
+Class \code{L2LocScaleShapeUnion} is a virtual class,
+extending class \code{L2GroupParamFamily} with new slot \code{locscaleshapename}
+(and, in fact, but not by S4 inheritance,
+containing classes \code{L2ScaleShapeUnion} and \code{L2LocationScaleFamily}).
+It is the parent class of class \code{GEVFamilyMuUnknown}.\cr
+Class \code{ParamWithLocAndScaleAndShapeFamParameterUnion} is a virtual class
+(union) containing classes \code{ParamWithScaleFamParameter} and
+\code{ParamWithShapeFamParameter}.\cr
+Class \code{ParamWithLocAndScaleAndShapeFamParameter} ``extends'' (no new
+slots) class \code{ParamWithScaleAndShapeFamParameter}. It is the class
+of the parameter in the class \code{GEVFamilyMuUnknown}.\cr
+}
+\section{Objects from these classes}{
+ Objects are only generated internally by the mentioned generating functions.
+}
+\section{Methods}{
+ \describe{
+ \item{locscaleshapename}{\code{signature(object = "L2LocationScaleShapeUnion")}:
+ accesses the respective slot of the class }
+ \item{locscalename}{\code{signature(object = "L2LocationScaleShapeUnion")}:
+ accesses the location and scale part of the respective slot of the class }
+ \item{scaleshapename}{\code{signature(object = "L2LocationScaleShapeUnion")}:
+ accesses the scale and shape part of the respective slot of the class }
+ \item{locationname}{\code{signature(object = "L2LocationScaleShapeUnion")}:
+ accesses the location part of the respective slot of the class }
+ \item{scalename}{\code{signature(object = "L2LocationScaleShapeUnion")}:
+ accesses the scale part of the respective slot of the class }
+ \item{shapename}{\code{signature(object = "L2LocationScaleShapeUnion")}:
+ accesses the shape part of the respective slot of the class }
+ \item{locscaleshapename<-}{\code{signature(object = "L2LocationScaleShapeUnion", value = "character")}:
+ replaces the respective slot of the class }
+}
+}
+
+\seealso{\code{\link[distrMod]{L2ParamFamily-class}},
+\code{\link[distrMod]{L2ScaleShapeUnion-class}},
+\code{\link[distrMod]{L2LocationScaleFamily-class}},
+\code{\link[distrMod]{ParamWithScaleAndShapeFamParameter-class}},
+\code{\link[distrMod]{ParamWithScaleFamParameter-class}},
+\code{\link[distrMod]{ParamWithShapeFamParameter-class}}.
+}
+
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
+%\note{}
+\concept{parametric family}
+\keyword{classes}
+\keyword{models}
+\keyword{internal}
Copied: branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyReturnClasses-class.Rd (from rev 987, branches/robast-1.1/pkg/RobExtremes/man/InternalReturnClasses-class.Rd)
===================================================================
--- branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyReturnClasses-class.Rd (rev 0)
+++ branches/robast-1.1/pkg/RobExtremes/man/internalProbFamilyReturnClasses-class.Rd 2018-07-19 11:39:26 UTC (rev 988)
@@ -0,0 +1,37 @@
+\name{InternalProbFamilyReturnClasses-class}
+\docType{class}
+\alias{InternalProbFamilyReturnClasses-class}
+\alias{GumbelLocationFamily-class}
+\alias{ParetoFamily-class}
+\alias{GEVFamily-class}
+\alias{GEVFamilyMuUnknown-class}
+\alias{GParetoFamily-class}
+\alias{WeibullFamily-class}
+
+\title{Internal return classes for generating functions}
+\description{Internal return classes for generating functions 'L2ParamFamily' and
+'L2LocationFamily' (and friends); used for particular method dispatch only}
+
+\section{Described classes}{
+In this file we describe classes \code{GParetoFamily}, \code{GEVFamily},
+\code{GEVFamilyMuUnknown}, \code{WeibullFamily} all ``extending''
+(no new slots!) class union
+\code{"L2LocationScaleShapeUnion"} and \code{ParetoFamily} ``extending''
+ (no new slots!) class \code{L2ParamFamily}.
+}
+
+\section{Objects from these classes}{
+ Objects are only generated internally by the mentioned generating functions.
+}
+
+\seealso{\code{\link[methods:BasicClasses]{numeric-class}},
+\code{\link{L2ParamFamily-class}},
+\code{\link{L2ScaleShapeUnion-class}},
+}
+
+\author{Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}}
+%\note{}
+\concept{parametric family}
+\keyword{classes}
+\keyword{models}
+\keyword{internal}
More information about the Robast-commits
mailing list