[Robast-commits] r951 - branches/robast-1.1/pkg/ROptEst/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Jul 16 23:32:40 CEST 2018
Author: ruckdeschel
Date: 2018-07-16 23:32:40 +0200 (Mon, 16 Jul 2018)
New Revision: 951
Modified:
branches/robast-1.1/pkg/ROptEst/man/0ROptEst-package.Rd
branches/robast-1.1/pkg/ROptEst/man/cniperCont.Rd
branches/robast-1.1/pkg/ROptEst/man/getMaxIneff.Rd
branches/robast-1.1/pkg/ROptEst/man/getReq.Rd
branches/robast-1.1/pkg/ROptEst/man/internal_Cniperplots.Rd
branches/robast-1.1/pkg/ROptEst/man/plot-methods.Rd
branches/robast-1.1/pkg/ROptEst/man/robest.Rd
branches/robast-1.1/pkg/ROptEst/man/roptest.Rd
Log:
[ROptEst] branach 1.1 some changes dontrun -> donttest, some extra arguments for non-labelled plotted data
Modified: branches/robast-1.1/pkg/ROptEst/man/0ROptEst-package.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/0ROptEst-package.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/0ROptEst-package.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -12,8 +12,8 @@
\details{
\tabular{ll}{
Package: \tab ROptEst \cr
-Version: \tab 1.0 \cr
-Date: \tab 2015-05-03 \cr
+Version: \tab 1.1.0 \cr
+Date: \tab 2018-07-16 \cr
Depends: \tab R(>= 2.14.0), methods, distr(>= 2.5.2), distrEx(>= 2.5), distrMod(>= 2.5.2),
RandVar(>= 0.9.2), RobAStBase(>= 1.0) \cr
Suggests: \tab RobLox, MASS \cr
@@ -21,7 +21,7 @@
ByteCompile: \tab yes \cr
License: \tab LGPL-3 \cr
URL: \tab http://robast.r-forge.r-project.org/\cr
-SVNRevision: \tab 728 \cr
+SVNRevision: \tab 940 \cr
}
}
\author{
Modified: branches/robast-1.1/pkg/ROptEst/man/cniperCont.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/cniperCont.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/cniperCont.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -11,34 +11,38 @@
other procedure.
}
\usage{
-cniperCont(IC1, IC2, data = NULL, ..., neighbor, risk, lower =
- getdistrOption("DistrResolution"), upper = 1 -
- getdistrOption("DistrResolution"), n = 101, scaleX =
- FALSE, scaleX.fct, scaleX.inv, scaleY = FALSE,
- scaleY.fct = pnorm, scaleY.inv = qnorm, scaleN = 9,
- x.ticks = NULL, y.ticks = NULL, cex.pts = 1,
- cex.pts.fun = NULL, col.pts = par("col"), pch.pts =
- 19, jit.fac = 1, jit.tol = .Machine$double.eps,
- with.lab = FALSE, lab.pts = NULL, lab.font = NULL,
- alpha.trsp = NA, which.lbs = NULL, which.Order = NULL,
- return.Order = FALSE, draw.nonlbl = TRUE, cex.nonlbl =
- 0.3, pch.nonlbl = ".", withSubst = TRUE)
+cniperCont(IC1, IC2, data = NULL, ...,
+ neighbor, risk, lower=getdistrOption("DistrResolution"),
+ upper=1-getdistrOption("DistrResolution"), n = 101,
+ with.automatic.grid = TRUE, scaleX = FALSE, scaleX.fct,
+ scaleX.inv, scaleY = FALSE, scaleY.fct = pnorm, scaleY.inv=qnorm,
+ scaleN = 9, x.ticks = NULL, y.ticks = NULL, cex.pts = 1,
+ cex.pts.fun = NULL, col.pts = par("col"), pch.pts = 19,
+ cex.npts = 0.6, cex.npts.fun = NULL, col.npts = "red", pch.npts = 20,
+ jit.fac = 1, jit.tol = .Machine$double.eps, with.lab = FALSE,
+ lab.pts = NULL, lab.font = NULL, alpha.trsp = NA, which.lbs = NULL,
+ which.Order = NULL, which.nonlbs = NULL, attr.pre = FALSE,
+ return.Order = FALSE, withSubst = TRUE)
cniperPoint(L2Fam, neighbor, risk, lower, upper)
-cniperPointPlot(L2Fam, data = NULL, ..., neighbor, risk = asMSE(),
- lower = getdistrOption("DistrResolution"), upper = 1 -
- getdistrOption("DistrResolution"), n = 101,
- withMaxRisk = TRUE, scaleX = FALSE, scaleX.fct,
- scaleX.inv, scaleY = FALSE, scaleY.fct = pnorm,
- scaleY.inv = qnorm, scaleN = 9, x.ticks = NULL,
- y.ticks = NULL, cex.pts = 1, cex.pts.fun = NULL,
- col.pts = par("col"), pch.pts = 19, jit.fac = 1,
- jit.tol = .Machine$double.eps, with.lab = FALSE,
- lab.pts = NULL, lab.font = NULL, alpha.trsp = NA,
- which.lbs = NULL, which.Order = NULL, return.Order =
- FALSE, draw.nonlbl = TRUE, cex.nonlbl = 0.3,
- pch.nonlbl = ".", withSubst = TRUE)
+cniperPointPlot(L2Fam, data=NULL, ..., neighbor, risk= asMSE(),
+ lower=getdistrOption("DistrResolution"),
+ upper=1-getdistrOption("DistrResolution"), n = 101,
+ withMaxRisk = TRUE, with.automatic.grid = TRUE,
+ scaleX = FALSE, scaleX.fct, scaleX.inv,
+ scaleY = FALSE, scaleY.fct = pnorm, scaleY.inv=qnorm,
+ scaleN = 9, x.ticks = NULL, y.ticks = NULL,
+ cex.pts = 1, cex.pts.fun = NULL, col.pts = par("col"),
+ pch.pts = 19,
+ cex.npts = 1, cex.npts.fun = NULL, col.npts = par("col"),
+ pch.npts = 19,
+ jit.fac = 1, jit.tol = .Machine$double.eps,
+ with.lab = FALSE,
+ lab.pts = NULL, lab.font = NULL, alpha.trsp = NA,
+ which.lbs = NULL, which.nonlbs = NULL,
+ which.Order = NULL, attr.pre = FALSE, return.Order = FALSE,
+ withSubst = TRUE)
}
\arguments{
\item{IC1}{ object of class \code{IC} }
@@ -62,6 +66,9 @@
with Dirac contamination in the evaluation point for both ICs
\eqn{\psi}{psi} and \eqn{\eta}{eta} which amounts to calling \code{cniperCont}
with \code{IC1=psi}, \code{IC2=eta}.}
+ \item{with.automatic.grid}{logical; should a grid be plotted alongside
+ with the ticks of the axes, automatically? If \code{TRUE} a respective
+ call to \code{grid} in argument \code{panel.first} is ignored. }
\item{scaleX}{logical; shall X-axis be rescaled (by default according to the cdf of
the underlying distribution)?}
\item{scaleY}{logical; shall Y-axis be rescaled (by default according to a probit scale)?}
@@ -86,13 +93,23 @@
if non-NULL, user-given x-ticks (on original scale);}
\item{y.ticks}{numeric; defaults to NULL; (then ticks are chosen automatically);
if non-NULL, user-given y-ticks (on original scale);}
- \item{cex.pts}{size of the points of the second argument plotted}
+ \item{cex.pts}{size of the points of the second argument plotted (vectorized);}
\item{cex.pts.fun}{rescaling function for the size of the points to be plotted;
either \code{NULL} (default), then \code{log(1+abs(x))} is used for
the rescaling, or a function which is then used for the
rescaling.}
- \item{col.pts}{color of the points of the second argument plotted}
- \item{pch.pts}{symbol of the points of the second argument plotted}
+ \item{col.pts}{color of the points of the second argument plotted (vectorized);}
+ \item{pch.pts}{symbol of the points of the second argument plotted (vectorized);}
+ \item{col.npts}{color of the non-labelled points of the \code{data} argument
+ plotted (vectorized);}
+ \item{pch.npts}{symbol of the non-labelled points of the \code{data} argument
+ plotted (vectorized);}
+ \item{cex.npts}{size of the non-labelled points of the \code{data} argument
+ plotted (vectorized);}
+ \item{cex.npts.fun}{rescaling function for the size of the non-labelled points
+ to be plotted; either \code{NULL} (default), then \code{log(1+abs(x))}
+ is used for each of the rescalings, or a function which is then used
+ for each of the rescalings.}
\item{with.lab}{logical; shall labels be plotted to the observations?}
\item{lab.pts}{character or NULL; labels to be plotted to the observations; if \code{NULL}
observation indices;}
@@ -111,21 +128,26 @@
for plotting points of the second argument in a jittered fashion.}
\item{which.lbs}{either an integer vector with the indices of the observations
to be plotted into graph or \code{NULL} --- then no observation is excluded}
+ \item{which.nonlbs}{indices of the observations which should be plotted but
+ not labelled; either an integer vector with the indices of the observations
+ to be plotted into graph or \code{NULL} --- then all non-labelled
+ observations are plotted.}
\item{which.Order}{we order the observations (descending) according to the norm given by
\code{normtype(object)}; then \code{which.Order}
either is an integer vector with the indices of the \emph{ordered}
observations (remaining after a possible reduction by argument \code{which.lbs})
to be plotted into graph or \code{NULL} --- then no (further) observation
is excluded.}
+ \item{attr.pre}{logical; do graphical attributes for plotted data refer
+ to indices prior (\code{TRUE}) or posterior to selection
+ via arguments \code{which.lbs}, \code{which.Order}, \code{which.nonlbs}
+ (\code{FALSE})? }
\item{return.Order}{logical; if \code{TRUE}, an order vector
is returned; more specifically, the order of the (remaining) observations
given by their original index is returned (remaining means: after a possible
reduction by argument \code{which.lbs}, and ordering is according to the norm given by
\code{normtype(object)});
otherwise we return \code{invisible()} as usual.}
- \item{draw.nonlbl}{logical; should non-labelled observations be drawn?}
- \item{cex.nonlbl}{character expansion(s) for non-labelled observations}
- \item{pch.nonlbl}{plotting symbol(s) for non-labelled observations}
\item{withSubst}{logical; if \code{TRUE} (default) pattern substitution for
titles and lables is used; otherwise no substitution is used. }
}
@@ -164,7 +186,16 @@
to Section~3.5 of Kohl et al. (2008) as well as Ruckdeschel (2004) and
the Introduction of Kohl (2005).
}
-\value{invisible() resp. cniper point is returned.}
+\value{The cniper point is returned by \code{cniperPoint}.
+In case of \code{cniperPointPlot}, we return
+an S3 object of class \code{c("plotInfo","DiagnInfo")}, i.e., a list
+ containing the information needed to produce the
+ respective plot, which at a later stage could be used by different
+ graphic engines (like, e.g. \code{ggplot}) to produce the plot
+ in a different framework. A more detailed description will follow in
+ a subsequent version.
+
+}
\references{
Kohl, M. and Ruckdeschel, H. and Rieder, H. (2008). Infinitesimally
Robust Estimation in General Smoothly Parametrized Models. Unpublished
@@ -196,7 +227,7 @@
risk = asMSE(), lower = 0, upper = 10)
## Don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
## cniper point
cniperPoint(P, neighbor = ContNeighborhood(radius = 0.5),
risk = asMSE(), lower = 0, upper = 4)
Modified: branches/robast-1.1/pkg/ROptEst/man/getMaxIneff.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/getMaxIneff.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/getMaxIneff.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -60,7 +60,7 @@
getMaxIneff(N0.ICR,neighbor)
## Don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
N0ls <- NormLocationScaleFamily()
ICsc <- makeIC(list(sin,cos),N0ls)
getMaxIneff(ICsc,neighbor)
Modified: branches/robast-1.1/pkg/ROptEst/man/getReq.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/getReq.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/getReq.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -46,8 +46,8 @@
getReq(asMSE(),neighbor,N0.ICA,N0.ICM,n=1)
getReq(asMSE(),neighbor,N0.ICA,N0.ICM,n=30)
-## Don't run to reduce check time on CRAN
-\dontrun{
+## Don't test to reduce check time on CRAN
+\donttest{
## RMX solution
N0.ICR <- radiusMinimaxIC(L2Fam=N0, neighbor=neighbor,risk=asMSE())
Modified: branches/robast-1.1/pkg/ROptEst/man/internal_Cniperplots.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/internal_Cniperplots.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/internal_Cniperplots.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -9,7 +9,7 @@
and \code{cniperPointPlot}.}
\usage{
-.plotData(data, dots, fun, L2Fam, IC, jit.fac, jit.tol )
+.plotData(data, dots, fun, L2Fam, IC, jit.fac, jit.tol, plotInfo )
.getFunCnip(IC1,IC2, risk, L2Fam, r, b20=NULL)
}
\arguments{
@@ -33,6 +33,7 @@
for plotting points of the second argument in a jittered fashion.}
\item{jit.tol}{jittering tolerance used in case of a \code{DiscreteDistribution}
for plotting points of the second argument in a jittered fashion.}
+ \item{plotInfo}{stored info from the plot}
}
\details{
\code{.plotData} takes argument \code{data} and plots it into the cniper graph.
Modified: branches/robast-1.1/pkg/ROptEst/man/plot-methods.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/plot-methods.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/plot-methods.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -18,7 +18,7 @@
N <- NormLocationScaleFamily(mean=0, sd=1)
IC <- optIC(model = N, risk = asCov())
## Don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
plot(IC, main = TRUE, panel.first= grid(),
col = "blue", cex.main = 2, cex.inner = 0.6,
withMBR=TRUE)
Modified: branches/robast-1.1/pkg/ROptEst/man/robest.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/robest.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/robest.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -58,8 +58,8 @@
\code{\link[RobAStBase]{UncondNeighborhood-class}},
\code{\link[distrMod]{RiskType-class}} }
\examples{
-## Don't run to reduce check time on CRAN
-\dontrun{
+## Don't test to reduce check time on CRAN
+\donttest{
#############################
## 1. Binomial data
#############################
Modified: branches/robast-1.1/pkg/ROptEst/man/roptest.Rd
===================================================================
--- branches/robast-1.1/pkg/ROptEst/man/roptest.Rd 2018-07-16 21:24:29 UTC (rev 950)
+++ branches/robast-1.1/pkg/ROptEst/man/roptest.Rd 2018-07-16 21:32:40 UTC (rev 951)
@@ -278,7 +278,7 @@
confint(MLest)
## Don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
## compute optimally robust estimator (known contamination)
## takes some time -> you can use package RobLox for normal
## location and scale which is optimized for speed
More information about the Robast-commits
mailing list