[Distr-commits] r1384 - in pkg/distrSim: . inst man tests/Examples
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sat Nov 12 22:37:37 CET 2022
Author: ruckdeschel
Date: 2022-11-12 22:37:37 +0100 (Sat, 12 Nov 2022)
New Revision: 1384
Modified:
pkg/distrSim/DESCRIPTION
pkg/distrSim/inst/NEWS
pkg/distrSim/man/0distrSim-package.Rd
pkg/distrSim/man/Contsimulation-class.Rd
pkg/distrSim/man/Dataclass-class.Rd
pkg/distrSim/man/Simulation-class.Rd
pkg/distrSim/tests/Examples/distrSim-Ex.Rout.save
Log:
[distrSim] 2.8.1 ready for release -- included some cleanup during examples / version before was for devel branch
Modified: pkg/distrSim/DESCRIPTION
===================================================================
--- pkg/distrSim/DESCRIPTION 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/DESCRIPTION 2022-11-12 21:37:37 UTC (rev 1384)
@@ -1,17 +1,17 @@
Package: distrSim
-Version: 2.8.0
-Date: 2019-03-12
+Version: 2.8.1
+Date: 2022-11-12
Title: Simulation Classes Based on Package 'distr'
Description: S4-classes for setting up a coherent framework for simulation within the distr
- family of packages.
+ family of packages.
Depends: R(>= 3.4), methods, graphics, setRNG(>= 2006.2-1), distr(>= 2.5.2)
Suggests: distrEx(>= 2.2)
Imports: startupmsg, stats, grDevices
-Authors at R: c(person("Florian", "Camphausen", role="ctb", comment="contributed as student in the
- initial phase --2005"), person("Matthias", "Kohl", role=c("aut", "cph")),
- person("Peter", "Ruckdeschel", role=c("cre", "cph"),
- email="peter.ruckdeschel at uni-oldenburg.de"), person("Thomas", "Stabla", role="ctb",
- comment="contributed as student in the initial phase --2005"))
+Authors at R: c(person("Florian", "Camphausen", role="ctb", comment="contributed as student in
+ the initial phase --2005"), person("Matthias", "Kohl", role=c("aut", "cph")),
+ person("Peter", "Ruckdeschel", role=c("cre", "cph"),
+ email="peter.ruckdeschel at uni-oldenburg.de"), person("Thomas", "Stabla",
+ role="ctb", comment="contributed as student in the initial phase --2005"))
ByteCompile: yes
License: LGPL-3
Encoding: latin1
@@ -18,4 +18,4 @@
URL: http://distr.r-forge.r-project.org/
LastChangedDate: {$LastChangedDate$}
LastChangedRevision: {$LastChangedRevision$}
-VCS/SVNRevision: 1319
+VCS/SVNRevision: 1380
Modified: pkg/distrSim/inst/NEWS
===================================================================
--- pkg/distrSim/inst/NEWS 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/inst/NEWS 2022-11-12 21:37:37 UTC (rev 1384)
@@ -18,6 +18,9 @@
\code{ggplot}) to produce the plot in a different framework. A more detailed description will follow in a subsequent version.
+ DESCRIPTION tag SVNRevision changed to VCS/SVNRevision
+under the hood:
++ fixed some broken URLs and changed URLs from http to https where possible
++ clean up in examples: files written to are unlinked at end of examples
##############
v 2.7
Modified: pkg/distrSim/man/0distrSim-package.Rd
===================================================================
--- pkg/distrSim/man/0distrSim-package.Rd 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/man/0distrSim-package.Rd 2022-11-12 21:37:37 UTC (rev 1384)
@@ -13,15 +13,15 @@
\details{
\tabular{ll}{
Package: \tab distrSim \cr
-Version: \tab 2.8.0 \cr
-Date: \tab 2019-03-12 \cr
+Version: \tab 2.8.1 \cr
+Date: \tab 2022-11-12 \cr
Depends: \tab R(>= 3.4), methods, graphics, setRNG(>= 2006.2-1), distr(>= 2.5.2) \cr
-Suggests: \tab distrEx(>= 2.2) \cr
-Imports: \tab startupmsg, stats, grDevices \cr
+Suggests: \tab distrEx(>= 2.2) \cr
+Imports: \tab startupmsg, stats, grDevices \cr
LazyLoad: \tab yes \cr
License: \tab LGPL-3 \cr
-URL: \tab http://distr.r-forge.r-project.org/\cr
-VCS/SVNRevision: \tab 1319 \cr
+URL: \tab https://distr.r-forge.r-project.org/\cr
+VCS/SVNRevision: \tab 1380 \cr
}
}
\section{Classes}{
@@ -47,7 +47,6 @@
Data.id(vectororNULL),
Data.c(vectororNULL)
}}
-
\section{Methods}{
\preformatted{
savedata Methods to save the data slot
@@ -66,13 +65,11 @@
cload loads just the comment slot
(for Simulation/Contsimulation)
}}
-
\section{Slot accessors / -replacement functions}{
All slots are inspected / modified by corresponding
accessors / -replacement functions, e.g. \code{rate(X)} for
an object of class \code{"Contsimulation"}.
}
-
\author{
Thomas Stabla \email{statho3 at web.de},\cr
Florian Camphausen \email{fcampi at gmx.de},\cr
@@ -80,23 +77,18 @@
Matthias Kohl \email{Matthias.Kohl at stamats.de}\cr
\emph{Maintainer:} Peter Ruckdeschel \email{peter.ruckdeschel at uni-oldenburg.de}
}
-
\section{Start-up-Banner}{
You may suppress the start-up banner/message completely by setting \code{options("StartupBanner"="off")}
somewhere before loading this package by \code{library} or \code{require} in your R-code / R-session.
-
If option \code{"StartupBanner"} is not defined (default) or setting
\code{options("StartupBanner"=NULL)} or \code{options("StartupBanner"="complete")}
the complete start-up banner is displayed.
-
For any other value of option \code{"StartupBanner"} (i.e., not in \code{c(NULL,"off","complete")})
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:StartupUtilities]{suppressStartupMessages}()} or
\code{\link[startupmsg:StartupUtilities]{onlytypeStartupMessages}(.,atypes="version")}.
}
-
\section{Far-reaching Change in Design}{
From version 1.8 of this package on, we have changed the format how data / simulations are stored:
In order to be able to cope with multivariate distributions, regression distributions and (later)
@@ -107,45 +99,35 @@
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.
}
-
\note{Global options controlling the plots and summaries of Dataclass and Simulation/Contsimulation
objects may be inspected / set by \code{\link{distrSimoptions}()}
and \code{\link{getdistrSimOption}()}.
}
-
-
\references{
P. Ruckdeschel, M. Kohl, T. Stabla, F. Camphausen (2006):
S4 Classes for Distributions, \emph{R News}, \emph{6}(2), 2-6.
\url{https://CRAN.R-project.org/doc/Rnews/Rnews_2006-2.pdf}
-
A vignette for packages \pkg{distr}, \pkg{distrSim}, \pkg{distrTEst}, and \pkg{distrEx}
is included into the mere documentation package \pkg{distrDoc} and may be called by
\code{require("distrDoc");vignette("distr")}.
-
%A more detailed manual for \pkg{distr}, \pkg{distrSim}, \pkg{distrTEst}, and \pkg{distrEx} may be downloaded from
%\url{http://www.uni-bayreuth.de/departments/math/org/mathe7/DISTR/distr.pdf}.
-
A homepage to this package is available under\cr
-\url{http://distr.r-forge.r-project.org/}
+\url{https://distr.r-forge.r-project.org/}
}
\section{Start-up-Banner}{
You may suppress the start-up banner/message completely by setting \code{options("StartupBanner"="off")}
somewhere before loading this package by \code{library} or \code{require} in your R-code / R-session.
-
If option \code{"StartupBanner"} is not defined (default) or setting
\code{options("StartupBanner"=NULL)} or \code{options("StartupBanner"="complete")}
the complete start-up banner is displayed.
-
For any other value of option \code{"StartupBanner"} (i.e., not in \code{c(NULL,"off","complete")})
only the version information is displayed.
-
As for general \code{packageStartupMessage}'s, you may also suppress all
the start-up banner by wrapping the \code{library} or \code{require}
call into \code{suppressPackageStartupMessages()} from
\pkg{startupmsg}-version 0.5 on.
}
-
\section{Package versions}{
Note: The first two numbers of package versions do not necessarily reflect
package-individual development, but rather are chosen for the
@@ -152,7 +134,6 @@
distrXXX family as a whole in order to ease updating "depends"
information.
}
-
\keyword{ package }
\concept{contaminated data}
\concept{contaminating data}
Modified: pkg/distrSim/man/Contsimulation-class.Rd
===================================================================
--- pkg/distrSim/man/Contsimulation-class.Rd 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/man/Contsimulation-class.Rd 2022-11-12 21:37:37 UTC (rev 1384)
@@ -119,6 +119,8 @@
savedata(cs) # saves the object in the working directory of R...
load("csim") # loads it again...
Data(cs) # ...without the data - use simulate to return it!
+## clean up
+unlink("csim")
}
\keyword{manip}
\concept{S4 data class}
Modified: pkg/distrSim/man/Dataclass-class.Rd
===================================================================
--- pkg/distrSim/man/Dataclass-class.Rd 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/man/Dataclass-class.Rd 2022-11-12 21:37:37 UTC (rev 1384)
@@ -120,6 +120,9 @@
Data(D) # the original data: matrix(c(1,2,3,4,5,6),2)
#if you have distrTEst available:
#evaluate(object = D, estimator = mean) # returns the mean of each variable
+## clean up
+unlink("xyz.sav")
+unlink("xyz.sav.comment")
}
\keyword{manip}
\concept{S4 data class}
Modified: pkg/distrSim/man/Simulation-class.Rd
===================================================================
--- pkg/distrSim/man/Simulation-class.Rd 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/man/Simulation-class.Rd 2022-11-12 21:37:37 UTC (rev 1384)
@@ -92,6 +92,7 @@
savedata(S) # saves the object in the directory of R...
load("xyz") # loads it again...
Data(S) # ...without the data - use simulate to return it!
+unlink("xyz")
}
\keyword{manip}
\concept{S4 data class}
Modified: pkg/distrSim/tests/Examples/distrSim-Ex.Rout.save
===================================================================
--- pkg/distrSim/tests/Examples/distrSim-Ex.Rout.save 2022-11-12 21:35:55 UTC (rev 1383)
+++ pkg/distrSim/tests/Examples/distrSim-Ex.Rout.save 2022-11-12 21:37:37 UTC (rev 1384)
@@ -1,7 +1,7 @@
-R Under development (unstable) (2019-02-27 r76167) -- "Unsuffered Consequences"
-Copyright (C) 2019 The R Foundation for Statistical Computing
-Platform: i386-w64-mingw32/i386 (32-bit)
+R Under development (unstable) (2022-09-25 r82916 ucrt) -- "Unsuffered Consequences"
+Copyright (C) 2022 The R Foundation for Statistical Computing
+Platform: x86_64-w64-mingw32/x64 (64-bit)
R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
@@ -21,6 +21,18 @@
> source(file.path(R.home("share"), "R", "examples-header.R"))
> options(warn = 1)
> options(pager = "console")
+> base::assign(".ExTimings", "distrSim-Ex.timings", pos = 'CheckExEnv')
+> base::cat("name\tuser\tsystem\telapsed\n", file=base::get(".ExTimings", pos = 'CheckExEnv'))
+> base::assign(".format_ptime",
++ function(x) {
++ if(!is.na(x[4L])) x[1L] <- x[1L] + x[4L]
++ if(!is.na(x[5L])) x[2L] <- x[2L] + x[5L]
++ options(OutDec = '.')
++ format(x[1L:3L], digits = 7L)
++ },
++ pos = 'CheckExEnv')
+>
+> ### * </HEADER>
> library('distrSim')
Loading required package: setRNG
Loading required package: distr
@@ -32,7 +44,7 @@
Loading required package: sfsmisc
:distr> Object Oriented Implementation of Distributions (version
-:distr> 2.8.0)
+:distr> 2.9.0)
:distr>
:distr> Attention: Arithmetics on distribution objects are
:distr> understood as operations on corresponding random variables
@@ -58,7 +70,7 @@
df, qqplot, sd
:distrSim> Simulation Classes Based on Package 'distr' (version
-:distrSim> 2.8.0)
+:distrSim> 2.8.1)
:distrSim>
:distrSim> Some functions from package 'stats' are intentionally
:distrSim> masked ---see distrSimMASK().
@@ -91,6 +103,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: Contsimulation-class
> ### Title: Class "Contsimulation"
> ### Aliases: Contsimulation-class Contsimulation
@@ -472,9 +485,13 @@
> load("csim") # loads it again...
> Data(cs) # ...without the data - use simulate to return it!
NULL
+> ## clean up
+> unlink("csim")
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("Contsimulation-class", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> cleanEx()
> nameEx("Dataclass-class")
> ### * Dataclass-class
@@ -481,6 +498,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: Dataclass-class
> ### Title: Class "Dataclass"
> ### Aliases: Dataclass-class initialize,Dataclass-method
@@ -495,7 +513,7 @@
number of runs: 1
dimension of the observations: 6
size of sample: 6
-object was generated by version: 2.8.0
+object was generated by version: 2.8.1
> #
> D <- Dataclass(Data = array(c(1,2,3,4,5,6),c(samplesize=2,obsdim=3,Runs=1)),
+ filename = "xyz.sav")
@@ -515,7 +533,7 @@
number of runs: 1
dimension of the observations: 3
size of sample: 2
-object was generated by version: 2.8.0
+object was generated by version: 2.8.1
> load("xyz.sav") # loads the original object "D"
> Data(D) # the original data: matrix(c(1,2,3,4,5,6),2)
, , 1
@@ -526,9 +544,14 @@
> #if you have distrTEst available:
> #evaluate(object = D, estimator = mean) # returns the mean of each variable
+> ## clean up
+> unlink("xyz.sav")
+> unlink("xyz.sav.comment")
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("Dataclass-class", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> cleanEx()
> nameEx("Simulation-class")
> ### * Simulation-class
@@ -535,6 +558,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: Simulation-class
> ### Title: Class "Simulation"
> ### Aliases: Simulation-class Simulation initialize,Simulation-method
@@ -766,9 +790,12 @@
> load("xyz") # loads it again...
> Data(S) # ...without the data - use simulate to return it!
NULL
+> unlink("xyz")
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("Simulation-class", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> cleanEx()
> nameEx("cload")
> ### * cload
@@ -775,6 +802,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: cload
> ### Title: cload
> ### Aliases: cload
@@ -795,6 +823,8 @@
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("cload", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> cleanEx()
> nameEx("distrSimMASK")
> ### * distrSimMASK
@@ -801,6 +831,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: distrSimMASK
> ### Title: Masking of/by other functions in package "distrSim"
> ### Aliases: distrSimMASK MASKING
@@ -824,6 +855,8 @@
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("distrSimMASK", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> cleanEx()
> nameEx("distrSimoptions")
> ### * distrSimoptions
@@ -830,6 +863,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: distrSimoptions
> ### Title: functions to change the global variables of the package
> ### 'distrSim'
@@ -876,6 +910,8 @@
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("distrSimoptions", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> cleanEx()
> nameEx("subsetting-methods")
> ### * subsetting-methods
@@ -882,6 +918,7 @@
>
> flush(stderr()); flush(stdout())
>
+> base::assign(".ptime", proc.time(), pos = "CheckExEnv")
> ### Name: Subsetting-methods
> ### Title: Subsetting/Indexing methods for SeqDataFrames objects in Package
> ### 'distrSim'
@@ -901,12 +938,14 @@
>
>
>
+> base::assign(".dptime", (proc.time() - get(".ptime", pos = "CheckExEnv")), pos = "CheckExEnv")
+> base::cat("subsetting-methods", base::get(".format_ptime", pos = 'CheckExEnv')(get(".dptime", pos = "CheckExEnv")), "\n", file=base::get(".ExTimings", pos = 'CheckExEnv'), append=TRUE, sep="\t")
> ### * <FOOTER>
> ###
> cleanEx()
> options(digits = 7L)
> base::cat("Time elapsed: ", proc.time() - base::get("ptime", pos = 'CheckExEnv'),"\n")
-Time elapsed: 12.88 0.48 22.66 NA NA
+Time elapsed: 4.54 0.15 4.73 NA NA
> grDevices::dev.off()
null device
1
More information about the Distr-commits
mailing list