[Distr-commits] r569 - branches/distr-2.2/pkg/distrSim/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Sep 4 12:11:58 CEST 2009
Author: stamats
Date: 2009-09-04 12:11:58 +0200 (Fri, 04 Sep 2009)
New Revision: 569
Added:
branches/distr-2.2/pkg/distrSim/man/distrSimoptions.Rd
Removed:
branches/distr-2.2/pkg/distrSim/man/distrSimOptions.Rd
Modified:
branches/distr-2.2/pkg/distrSim/man/0distrSim-package.Rd
branches/distr-2.2/pkg/distrSim/man/subsetting-methods.Rd
branches/distr-2.2/pkg/distrSim/man/versionmanagement.Rd
Log:
html-Links should work now in package distrSim
Modified: branches/distr-2.2/pkg/distrSim/man/0distrSim-package.Rd
===================================================================
--- branches/distr-2.2/pkg/distrSim/man/0distrSim-package.Rd 2009-09-04 10:11:37 UTC (rev 568)
+++ branches/distr-2.2/pkg/distrSim/man/0distrSim-package.Rd 2009-09-04 10:11:58 UTC (rev 569)
@@ -91,7 +91,8 @@
only the version information is displayed.
The same can be achieved by wrapping the \code{library} or \code{require} call into
-either \code{\link[startupmsg]{suppressStartupMessages}()} or \code{\link[startupmsg]{onlytypeStartupMessages}(.,atypes="version")}.
+either \code{\link[startupmsg:StartupUtilities]{suppressStartupMessages}()} or
+\code{\link[startupmsg:StartupUtilities]{onlytypeStartupMessages}(.,atypes="version")}.
}
\section{Far-reaching Change in Design}{
@@ -100,7 +101,7 @@
time series distributions, we have switched to the common array format:
samplesize x obsDim x runs; you may check the version under which an object was generated by
\code{\link{getVersion}}; for saved objects from earlier versions, we provide the functions
- \code{\link[distr]{isOldVersion}}, and \code{\link{conv2NewVersion-methods}}
+ \code{\link[distr:versionmanagement]{isOldVersion}}, and \code{\link{conv2NewVersion-methods}}
to check whether the object was generated by an older version of this package and to convert
such an object to the new format, respectively.
}
@@ -151,5 +152,5 @@
\concept{S4 simulation class}
\concept{S4 data class}
\seealso{
-\code{\link[distr]{distr}} \code{\link[setRNG]{setRNG}}
+\code{\link[distr:0distr-packages]{distr-package}} \code{\link[setRNG]{setRNG}}
}
Deleted: branches/distr-2.2/pkg/distrSim/man/distrSimOptions.Rd
===================================================================
--- branches/distr-2.2/pkg/distrSim/man/distrSimOptions.Rd 2009-09-04 10:11:37 UTC (rev 568)
+++ branches/distr-2.2/pkg/distrSim/man/distrSimOptions.Rd 2009-09-04 10:11:58 UTC (rev 569)
@@ -1,57 +0,0 @@
-\name{distrSimoptions}
-\alias{distrSimoptions}
-\alias{getdistrSimOption}
-\alias{MaxNumberofPlottedObsDims}
-\alias{MaxNumberofPlottedRuns}
-\alias{MaxNumberofSummarizedObsDims}
-\alias{MaxNumberofSummarizedRuns}
-
-\title{
- functions to change the global variables of the package `distrSim'
-}
-\description{
- With \code{distrSimoptions} and \code{getdistrSimOption} you may inspect and change the global
- variables used by package \pkg{distrSim}.
-}
-\usage{
-distrSimoptions(...)
-getdistrSimOption(x)
-}
-\arguments{
- \item{\dots}{ any options can be defined, using name = value or by passing a list of such tagged values. }
- \item{x}{ a character string holding an option name.}
-}
-\details{Invoking \code{distrSimoptions()} with no arguments returns a list with the current values of the options.
- To access the value of a single option, one should use \code{getdistrSimOption("MaxNumberofSummarizedRuns")},
- e.g., rather than \code{distroptions("MaxNumberofSummarizedRuns")} which is a \emph{list} of length one.}
-\value{
-\code{distrSimoptions()} returns a list of the global options of \pkg{distrSim}. \cr
-\code{distrSimoptions("MaxNumberofSummarizedRuns")} returns the global option \code{MaxNumberofSummarizedRuns} as a list of length 1. \cr
-\code{distrSimoptions("MaxNumberofSummarizedRuns" = 3)} sets the value of the global option \code{MaxNumberofSummarizedRuns} to 3.
-\code{getdistrSimOption("MaxNumberofSummarizedRuns")} the current value set for option \code{MaxNumberofSummarizedRuns}.
-}
-
-\section{Currently available options}{
-\describe{
- \item{MaxNumberofPlottedObs}{ maximal number of observation plotted; defaults to 4000 }
- \item{MaxNumberofPlottedObsDims}{ maximal number of observation dimensions plotted in parallel; defaults to 6}
- \item{MaxNumberofPlottedRuns}{ maximal number of runs plotted in parallel; defaults to 6 }
- \item{MaxNumberofSummarizedObsDims}{ maximal number of observation dimensions summarized in parallel; defaults to 6 }
- \item{MaxNumberofSummarizedRuns}{ maximal number of runs summarized in parallel; defaults to 6 }
-}
-}
-%\references{}
-\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
-%\note{}
-\seealso{\code{\link[base]{options}}, \code{\link[base]{getOption}},
-\code{\link[distr]{distroptions}}, \code{\link[distr]{getdistrOption}}}
-\examples{
-distrSimoptions()
-distrSimoptions("MaxNumberofPlottedObsDims")
-distrSimoptions("MaxNumberofPlottedObsDims" = 5)
-# or
-getdistrSimOption("MaxNumberofPlottedObsDims")
-}
-\keyword{misc}
-\concept{global options}
-\concept{options}
Copied: branches/distr-2.2/pkg/distrSim/man/distrSimoptions.Rd (from rev 564, branches/distr-2.2/pkg/distrSim/man/distrSimOptions.Rd)
===================================================================
--- branches/distr-2.2/pkg/distrSim/man/distrSimoptions.Rd (rev 0)
+++ branches/distr-2.2/pkg/distrSim/man/distrSimoptions.Rd 2009-09-04 10:11:58 UTC (rev 569)
@@ -0,0 +1,57 @@
+\name{distrSimoptions}
+\alias{distrSimoptions}
+\alias{getdistrSimOption}
+\alias{MaxNumberofPlottedObsDims}
+\alias{MaxNumberofPlottedRuns}
+\alias{MaxNumberofSummarizedObsDims}
+\alias{MaxNumberofSummarizedRuns}
+
+\title{
+ functions to change the global variables of the package `distrSim'
+}
+\description{
+ With \code{distrSimoptions} and \code{getdistrSimOption} you may inspect and change the global
+ variables used by package \pkg{distrSim}.
+}
+\usage{
+distrSimoptions(...)
+getdistrSimOption(x)
+}
+\arguments{
+ \item{\dots}{ any options can be defined, using name = value or by passing a list of such tagged values. }
+ \item{x}{ a character string holding an option name.}
+}
+\details{Invoking \code{distrSimoptions()} with no arguments returns a list with the current values of the options.
+ To access the value of a single option, one should use \code{getdistrSimOption("MaxNumberofSummarizedRuns")},
+ e.g., rather than \code{distroptions("MaxNumberofSummarizedRuns")} which is a \emph{list} of length one.}
+\value{
+\code{distrSimoptions()} returns a list of the global options of \pkg{distrSim}. \cr
+\code{distrSimoptions("MaxNumberofSummarizedRuns")} returns the global option \code{MaxNumberofSummarizedRuns} as a list of length 1. \cr
+\code{distrSimoptions("MaxNumberofSummarizedRuns" = 3)} sets the value of the global option \code{MaxNumberofSummarizedRuns} to 3.
+\code{getdistrSimOption("MaxNumberofSummarizedRuns")} the current value set for option \code{MaxNumberofSummarizedRuns}.
+}
+
+\section{Currently available options}{
+\describe{
+ \item{MaxNumberofPlottedObs}{ maximal number of observation plotted; defaults to 4000 }
+ \item{MaxNumberofPlottedObsDims}{ maximal number of observation dimensions plotted in parallel; defaults to 6}
+ \item{MaxNumberofPlottedRuns}{ maximal number of runs plotted in parallel; defaults to 6 }
+ \item{MaxNumberofSummarizedObsDims}{ maximal number of observation dimensions summarized in parallel; defaults to 6 }
+ \item{MaxNumberofSummarizedRuns}{ maximal number of runs summarized in parallel; defaults to 6 }
+}
+}
+%\references{}
+\author{Peter Ruckdeschel \email{Peter.Ruckdeschel at itwm.fraunhofer.de}}
+%\note{}
+\seealso{\code{\link[base]{options}}, \code{\link[base:options]{getOption}},
+\code{\link[distr]{distroptions}}, \code{\link[distr:distroptions]{getdistrOption}}}
+\examples{
+distrSimoptions()
+distrSimoptions("MaxNumberofPlottedObsDims")
+distrSimoptions("MaxNumberofPlottedObsDims" = 5)
+# or
+getdistrSimOption("MaxNumberofPlottedObsDims")
+}
+\keyword{misc}
+\concept{global options}
+\concept{options}
Property changes on: branches/distr-2.2/pkg/distrSim/man/distrSimoptions.Rd
___________________________________________________________________
Name: svn:keywords
+
Name: svn:mergeinfo
+
Modified: branches/distr-2.2/pkg/distrSim/man/subsetting-methods.Rd
===================================================================
--- branches/distr-2.2/pkg/distrSim/man/subsetting-methods.Rd 2009-09-04 10:11:37 UTC (rev 568)
+++ branches/distr-2.2/pkg/distrSim/man/subsetting-methods.Rd 2009-09-04 10:11:58 UTC (rev 569)
@@ -31,7 +31,7 @@
}
\value{again an object of class \code{SeqDataFrames} with the prescribed indices / values}
-\seealso{\code{\link[base]{"["}}}
+\seealso{\code{\link[base:Extract]{"["}}}
\examples{
s0 <- matrix(1:6,3,2)
d0 <- data.frame(s0)
Modified: branches/distr-2.2/pkg/distrSim/man/versionmanagement.Rd
===================================================================
--- branches/distr-2.2/pkg/distrSim/man/versionmanagement.Rd 2009-09-04 10:11:37 UTC (rev 568)
+++ branches/distr-2.2/pkg/distrSim/man/versionmanagement.Rd 2009-09-04 10:11:58 UTC (rev 569)
@@ -31,6 +31,6 @@
samplesize x obsDim x runs (new format)}
}
}
-\seealso{\code{\link[distr]{isOldVersion}}, \code{\link[distr]{conv2NewVersion}}}
+\seealso{\code{\link[distr:versionmanagement]{isOldVersion}}, \code{\link[distr:versionmanagement]{conv2NewVersion}}}
\keyword{utilities}
\concept{version management}
More information about the Distr-commits
mailing list