[Robast-commits] r948 - branches/robast-1.1/pkg/RobAStBase/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Jul 16 04:33:30 CEST 2018
Author: ruckdeschel
Date: 2018-07-16 04:33:28 +0200 (Mon, 16 Jul 2018)
New Revision: 948
Modified:
branches/robast-1.1/pkg/RobAStBase/man/comparePlot.Rd
branches/robast-1.1/pkg/RobAStBase/man/infoPlot.Rd
branches/robast-1.1/pkg/RobAStBase/man/internal_GridHelpers.Rd
branches/robast-1.1/pkg/RobAStBase/man/internal_plots.Rd
branches/robast-1.1/pkg/RobAStBase/man/internals.Rd
branches/robast-1.1/pkg/RobAStBase/man/kStepEstimator.Rd
branches/robast-1.1/pkg/RobAStBase/man/makeIC-methods.Rd
Log:
[RobAStBase] branch 1.1 manuals updated: \donttest and some utilities
Modified: branches/robast-1.1/pkg/RobAStBase/man/comparePlot.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/comparePlot.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/comparePlot.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -296,8 +296,9 @@
which.Order = 1:6,
return.Order = TRUE)
-## don't run to reduce check time on CRAN
-\dontrun{
+
+## don't test to reduce check time on CRAN
+\donttest{
## selection of subpanels for plotting
par(mfrow=c(1,1))
comparePlot(IC1, IC2 ,mfColRow = FALSE, to.draw.arg=c("mean"),
Modified: branches/robast-1.1/pkg/RobAStBase/man/infoPlot.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/infoPlot.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/infoPlot.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -298,7 +298,7 @@
infoPlot(IC1)
## don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
## selection of subpanels for plotting
par(mfrow=c(1,2))
infoPlot(IC1, mfColRow = FALSE, to.draw.arg=c("Abs","sd"))
Modified: branches/robast-1.1/pkg/RobAStBase/man/internal_GridHelpers.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/internal_GridHelpers.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/internal_GridHelpers.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -2,6 +2,7 @@
\alias{internal_helpers_for_producing_grids_in_plots_RobAStBase}
\alias{.getDimsTD}
\alias{.producePanelFirstS}
+\alias{.producePanelFirstSn}
\title{Internal / Helper functions of package RobAStBase for grids in plot functions}
@@ -12,11 +13,25 @@
\usage{
.getDimsTD(L2Fam,to.draw.arg)
.producePanelFirstS(panelFirst,IC,to.draw.arg, isInfoPlot=FALSE,
- x.ticks, scaleX, scaleX.fct,
- y.ticks, scaleY, scaleY.fct)
+ x.ticks, scaleX, scaleX.fct,
+ y.ticks, scaleY, scaleY.fct)
+.producePanelFirstSn(panelFirst, x.ticks, scaleX, scaleX.fct,
+ y.ticks, scaleY, scaleY.fct)
}
\arguments{
\item{L2Fam}{the model at which the plot is produced (of class \code{L2ParamFamily}).}
+ \item{panelFirst}{argument \code{panel.first} to be mingled for grid plotting.}
+ \item{x.ticks}{numeric: coordinates in original scale of user-given ticks on x-axis.}
+ \item{scaleX}{logical; shall X-axis be rescaled (by default according to the cdf of
+ the underlying distribution)?}
+ \item{scaleX.fct}{an isotone, vectorized function mapping the domain of the IC
+ to [0,1]; if \code{scaleX} is \code{TRUE} and \code{scaleX.fct} is
+ missing, the cdf of the underlying observation distribution.}
+ \item{y.ticks}{numeric: coordinates in original scale of user-given ticks on y-axis.}
+ \item{scaleY}{logical; shall Y-axis be rescaled (by default according to a probit scale)?}
+ \item{scaleY.fct}{an isotone, vectorized function mapping for each coordinate the
+ range of the respective coordinate of the IC
+ to [0,1]; defaulting to the cdf of \eqn{{\cal N}(0,1)}{N(0,1)}.}
\item{to.draw.arg}{Either \code{NULL} (default;
everything is plotted) or a vector of either integers
(the indices of the subplots to be drawn) or characters
@@ -28,21 +43,9 @@
vector \code{"dim<dimnr>"}, \code{dimnr} running through
the number of rows of the trafo matrix.
}
- \item{panelFirst}{argument \code{panel.first} to be mingled for grid plotting.}
\item{IC}{object of class \code{"InfluenceCurve"} }
\item{isInfoPlot}{logical; is this function to be used in \code{infoPlot} or
(\code{TRUE}) in another plot (\code{FALSE})? }
- \item{x.ticks}{numeric: coordinates in original scale of user-given ticks on x-axis.}
- \item{scaleX}{logical; shall X-axis be rescaled (by default according to the cdf of
- the underlying distribution)?}
- \item{scaleX.fct}{an isotone, vectorized function mapping the domain of the IC
- to [0,1]; if \code{scaleX} is \code{TRUE} and \code{scaleX.fct} is
- missing, the cdf of the underlying observation distribution.}
- \item{y.ticks}{numeric: coordinates in original scale of user-given ticks on y-axis.}
- \item{scaleY}{logical; shall Y-axis be rescaled (by default according to a probit scale)?}
- \item{scaleY.fct}{an isotone, vectorized function mapping for each coordinate the
- range of the respective coordinate of the IC
- to [0,1]; defaulting to the cdf of \eqn{{\cal N}(0,1)}{N(0,1)}.}
}
\details{
\code{.getDimsTD} computes the number of panels to be plotted.
Modified: branches/robast-1.1/pkg/RobAStBase/man/internal_plots.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/internal_plots.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/internal_plots.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -7,6 +7,11 @@
\alias{.makedotsP}
\alias{.makedotsLowLevel}
\alias{.cexscale}
+\alias{.getX.vec}
+\alias{.getXlimYlim}
+\alias{.prepareTitles}
+\alias{.getToDraw}
+\alias{.preparePanelFirstLast}
\title{Internal / Helper functions of package RobAStBase for plot functions}
@@ -27,6 +32,13 @@
.makedotsP(dots)
.makedotsLowLevel(dots)
.cexscale(y, y1=y, maxcex=4,mincex=0.05,cex, fun=NULL)
+.getX.vec(distr, dims0, lty, x.vec, scaleX, scaleX.fct, scaleX.inv, xm, xM)
+.getXlimYlim(dots,dotsP, dims0, xlim, ylim)
+.prepareTitles(withSubst, presubArg2, presubArg3, dots, mainText,
+ L2Fam, inner, dims0, dims, to.draw, trafO, obj, type, bmar, tmar)
+.getToDraw(dims, trafO, L2Fam, to.draw.arg, Abs=NULL)
+.preparePanelFirstLast(with.automatic.grid , dims0, pF.0, pL.0,
+ logArg, scaleX, scaleY, x.ticks, y.ticks, scaleX.fct, scaleY.fct)
}
\arguments{
\item{scaleX}{logical; shall X-axis be rescaled (by default according to the cdf of
@@ -84,12 +96,56 @@
\code{y.ticks} are both \code{NULL}, a respective box is drawn around the
panel; otherwise no box is drawn in this case. }
\item{dots}{a list; intended to be the \code{\dots} argument of \code{plot}. }
- \item{y}{}
- \item{y1}{}
- \item{maxcex}{}
- \item{mincex}{}
- \item{cex}{}
- \item{fun}{}
+ \item{y}{input at which to compute \code{cex}-values (for these \code{y} values)}
+ \item{y1}{secondary input of \code{y}-values which is also used for
+ computaiton but not plotted itself at this \code{cex} value.}
+ \item{maxcex}{maximal value for \code{cex}}
+ \item{mincex}{minimal value for \code{cex}}
+ \item{cex}{basic factor for \code{cex}}
+ \item{fun}{(optional) function to compute the \code{cex}-values acc. to the
+ \code{y} and \code{y1}-values.}
+\item{L2Fam}{L2-Family},
+\item{to.draw.arg}{resp. argument from the user-interface of \code{comparePlot}, \code{infoPlot}, and the
+\code{plot}-method for ICs, i.e., either \code{NULL} (default;
+everything is plotted) or a vector of either integers (the indices of the
+subplots to be drawn) or characters --- the names of the subplots to be drawn:
+these names are to be chosen either among the row names of the trafo matrix
+\code{rownames(trafo(eval(x at CallL2Fam)@param))} or if the last expression is
+\code{NULL} a vector \code{"dim<dimnr>"}, \code{dimnr} running through
+the number of rows of the trafo matrix.}
+\item{panelFirst}{the \code{panel.first} expression to be extended}
+\item{distr}{underlying distribution of the observations}
+\item{dims0}{number of panels to be plotted}
+\item{lty}{the \code{lty} argument used in the user interface}
+\item{x.vec}{the resp. argument from the user interface.}
+\item{xm}{minimal x-value}
+\item{xM}{maximal x-value}
+\item{dots}{the internal \code{dots}-variable to be changed}
+\item{dotsP}{the internal \code{dotsP}-variable to be changed (taking up
+ additional arguments for the calls to \code{plot})}
+\item{xlim}{the possibly matrix-valued argument of the user interface}
+\item{ylim}{the possibly matrix-valued argument of the user interface}
+\item{withSubst}{should substitutions be made in titles?}
+\item{presubArg2}{title part}
+\item{presubArg3}{title part}
+\item{mainText}{text to be used for \code{main}}
+\item{inner}{the resp. argument from the user interface.}
+\item{dims}{the dimension of the pIC}
+\item{to.draw}{the actual numbers / names of the plotted panels.}
+\item{trafO}{the parameter transformation of \code{L2fam at param}.}
+\item{obj}{the object from which to draw the name (of the plot).}
+\item{type}{for which type of plot should the titles be produced -- \code{"info"},
+\code{"all"} or \code{compare}.}
+\item{bmar}{resp. argument from the user-interface of \code{comparePlot}, \code{infoPlot}, and the
+\code{plot}-method for ICs.}
+\item{tmar}{resp. argument from the user-interface of \code{comparePlot}, \code{infoPlot}, and the
+\code{plot}-method for ICs.}
+\item{Abs}{additional text template used in \code{infoPlot}.}
+\item{with.automatic.grid}{}
+\item{pF.0}{the \code{panel.first} expression given by rhe user}
+\item{pL.0}{the \code{panel.last} expression given by rhe user}
+\item{logArg}{a character vector with \code{log}-arguments for \code{plot}
+for each of the plotted panels.}
}
\details{
\code{.rescalefct} rescales, if necessary, x and y axis for use in plot
@@ -148,6 +204,19 @@
by which the rescaling is done; by default this argument is \code{NULL}
and in this case the function \code{log(1+abs(x))} is used.
}
+\code{.getDimsTD}{returns the number of different coordinates to be plotted.}
+\code{.producePanelFirstS}{for each graphical panel inserts
+ (if needed) x and y tickmarks for user-specific axes
+ into a \code{panel.first} expression.}
+\code{.getX.vec}{produces the x-grid (on original scale) for each of the panels
+ and decides whether to plot lines or points.}
+
+\code{.getXlimYlim}{produces panel-wise \code{xlim} and \code{ylim} arguments
+ as well as left and right endpoints of the x-scalas.}
+\code{.prepareTitles}{produces the titles for the panels}
+\code{.getToDraw}{computes which panels are to be drawn}
+\code{.preparePanelFirstLast}{prepares the \code{panel.first} and \code{panel.last}
+ expressions for each of the panels.}
}
Modified: branches/robast-1.1/pkg/RobAStBase/man/internals.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/internals.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/internals.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -2,6 +2,7 @@
\alias{internals_for_RobAStBase}
\alias{.eq}
\alias{.getDistr}
+\alias{.msapply}
\title{Internal / Helper functions of package RobAStBase}
@@ -12,14 +13,22 @@
.eq(x,y = 0*x, tol = 1e-7)
.getDistr(L2Fam)
.evalListRec(list0)
+.msapply(X, FUN, ..., simplify = TRUE, USE.NAMES = TRUE)
}
-
\arguments{
\item{x}{a (numeric) vector}
\item{y}{a (numeric) vector}
\item{tol}{numeric --- tolerance}
\item{L2fam}{object of class \code{L2ParamFamily}}
\item{list0}{a list}
+ \item{X}{like \code{sapply}: a vector (atomic or list) or an \code{expression} object. Other objects
+ (including classed objects) will be coerced by \code{base::as.list}.}
+ \item{FUN}{like \code{sapply}: the function to be applied to each element of \code{X}. See also \code{\link[base]{sapply}}}
+ \item{\dots}{like \code{sapply}: optional arguments to \code{FUN}.}
+ \item{simplify}{like \code{sapply}: logical or character string;
+ should the result be simplified to a vector, matrix or higher dimensional array if possible? See also \code{\link[base]{sapply}}}
+ \item{USE.NAMES}{like \code{sapply}: logical; if \code{TRUE} and if \code{X} is character,
+ use \code{X} as names for the result unless it had names already.}
}
\details{
@@ -27,6 +36,7 @@
\code{.getDistr} produces a string with the class of the family and its parameter value;
\code{.evalListRec} recursively goes through the entries of a list, evaluating
each entry.
+\code{.msapply} like \code{base::.sapply} but catches \code{NULL}/zero-length arguments \code{X}.
}
@@ -34,6 +44,7 @@
\item{.eq}{(a vector of) \code{logical}.}
\item{.getDistr}{\code{character}.}
\item{.evalListRec}{a list.}
+\item{.msapply}{as \code{base::sapply}.}
}
Modified: branches/robast-1.1/pkg/RobAStBase/man/kStepEstimator.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/kStepEstimator.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/kStepEstimator.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -103,7 +103,7 @@
start(est1)
## don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
## a transformed model
tfct <- function(x){
nms0 <- c("mean","sd")
Modified: branches/robast-1.1/pkg/RobAStBase/man/makeIC-methods.Rd
===================================================================
--- branches/robast-1.1/pkg/RobAStBase/man/makeIC-methods.Rd 2018-07-13 00:50:20 UTC (rev 947)
+++ branches/robast-1.1/pkg/RobAStBase/man/makeIC-methods.Rd 2018-07-16 02:33:28 UTC (rev 948)
@@ -102,7 +102,7 @@
checkIC(IC5)
## don't run to reduce check time on CRAN
-\dontrun{
+\donttest{
N0 <- NormLocationScaleFamily()
IC6 <- makeIC(list(sin,cos),N0)
plot(IC6)
More information about the Robast-commits
mailing list