[Robast-commits] r703 - pkg/RobAStBase/man

[noreply at r-forge.r-project.org]

Author: ruckdeschel
Date: 2013-09-12 11:49:04 +0200 (Thu, 12 Sep 2013)
New Revision: 703

Added:
   pkg/RobAStBase/man/interpolRisk-class.Rd
   pkg/RobAStBase/man/samplesize-methods.Rd
Log:
and yet some ...

Added: pkg/RobAStBase/man/interpolRisk-class.Rd
===================================================================
--- pkg/RobAStBase/man/interpolRisk-class.Rd	                        (rev 0)
+++ pkg/RobAStBase/man/interpolRisk-class.Rd	2013-09-12 09:49:04 UTC (rev 703)
@@ -0,0 +1,58 @@
+\name{interpolRisk-class}
+\docType{class}
+\alias{interpolRisk-class}
+\alias{OMSRRisk-class}
+\alias{RMXRRisk-class}
+\alias{MBRRisk-class}
+\alias{OMSRRisk}
+\alias{RMXRRisk}
+\alias{MBRRisk}
+
+\usage{
+MBRRisk(samplesize=100)
+OMSRRisk(samplesize=100)
+RMXRRisk(samplesize=100)
+}
+\arguments{
+  \item{samplesize}{sample size at which to look at the risk.}
+}
+\title{Interpolated Risks}
+\description{Class of risks for which algorithms dispatch to speed-up algorithms}
+\section{Objects from the Class}{\code{interpolRisk} is a virtual class: No objects may be created from it.
+the other classes are generated via generating functions.
+}
+\section{Slots}{
+  \describe{
+    \item{\code{type}}{Object of class \code{"character"}:
+      type of risk. (Inherited from \code{RiskType}).}
+  }
+}
+\details{
+The main purpose of classes \code{OMSRRisk}, \code{MBRRisk}, and
+\code{RMXRRisk} is to help to dispatch into speed-up algorithms later
+in function \code{roptest}. In all these risks, we assume
+convex contamination neighborhoods.
+\code{OMSRRisk} stands for optimal MSE-robust estimation (where we assume
+a radius r of \code{0.5}), \code{RMXRRisk} stands for optimal
+optimally RMX-robust estimation and \code{MBRRisk} stands for optimal
+Bias-robust estimation.
+All these risks have an additional slot samplesize, defaulting to \code{100},
+and for which there is a replacement and an accessor method.
+}
+%\references{}
+\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+\examples{
+new("OMSRRisk")
+OMSRRisk()
+RMXRRisk()
+MBRRisk()
+myrisk <- MBRRisk(samplesize=100)
+samplesize(myrisk)
+samplesize(myrisk) <- 20
+}
+
+%\note{}
+%\seealso{}
+%\examples{}
+\concept{risk}
+\keyword{classes}

Added: pkg/RobAStBase/man/samplesize-methods.Rd
===================================================================
--- pkg/RobAStBase/man/samplesize-methods.Rd	                        (rev 0)
+++ pkg/RobAStBase/man/samplesize-methods.Rd	2013-09-12 09:49:04 UTC (rev 703)
@@ -0,0 +1,23 @@
+\name{samplesize-methods}
+\docType{methods}
+\alias{samplesize,interpolRisk-method}
+\alias{samplesize}
+\alias{samplesize<-,interpolRisk-method}
+\alias{samplesize<-}
+\title{Methods for Function samplesize  in Package `RobAStBase'}
+\description{samplesize-methods}
+
+\section{Methods}{\describe{
+
+\item{samplesize}{\code{signature(object = "interpolrisk")}:
+  returns the slot \code{samplesize} of an object of class \code{"interpolrisk"}. }
+\item{samplesize<-}{\code{signature(object = "interpolrisk", value = "ANY")}:
+  modifies the slot \code{samplesize} of an object of class \code{"interpolrisk"}. }
+}}
+\examples{
+myrisk <- MBRRisk(samplesize=100)
+samplesize(myrisk)
+samplesize(myrisk) <- 20
+}
+\concept{risk}
+\keyword{classes}