aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2021-01-14 17:15:54 +0000
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2021-01-14 17:15:54 +0000
commit3409fc9201cc8ca460d36b77fb65f09b3d2f3be9 (patch)
tree5d2b35944af343f15ecb7dbd3e74f91a95ca2c3f
parentMove R package to separate directory (diff)
downloadSyncRNG-3409fc9201cc8ca460d36b77fb65f09b3d2f3be9.tar.gz
SyncRNG-3409fc9201cc8ca460d36b77fb65f09b3d2f3be9.zip
bump roxygen
-rw-r--r--new_R/DESCRIPTION2
-rw-r--r--new_R/man/SyncRNG-class.Rd7
-rw-r--r--new_R/man/syncrng-package.Rd8
3 files changed, 9 insertions, 8 deletions
diff --git a/new_R/DESCRIPTION b/new_R/DESCRIPTION
index 12c5191..141743a 100644
--- a/new_R/DESCRIPTION
+++ b/new_R/DESCRIPTION
@@ -12,4 +12,4 @@ Imports:
methods
Suggests:
testthat
-RoxygenNote: 5.0.1
+RoxygenNote: 7.1.1
diff --git a/new_R/man/SyncRNG-class.Rd b/new_R/man/SyncRNG-class.Rd
index 7a2c69b..92316da 100644
--- a/new_R/man/SyncRNG-class.Rd
+++ b/new_R/man/SyncRNG-class.Rd
@@ -2,8 +2,8 @@
% Please edit documentation in R/SyncRNG.R
\docType{class}
\name{SyncRNG-class}
-\alias{SyncRNG}
\alias{SyncRNG-class}
+\alias{SyncRNG}
\title{A Reference Class for SyncRNG}
\description{
See \link{syncrng-package} for package documentation.
@@ -16,6 +16,7 @@ See \link{syncrng-package} for package documentation.
\item{\code{state}}{The current state of the RNG, should not be modified by the
user}
}}
+
\section{Methods}{
\describe{
@@ -29,10 +30,10 @@ user}
\item{\code{shuffle(x)}}{Randomly shuffle a provided array of values}
}}
+
\examples{
s <- SyncRNG(seed=123456)
for (i in 1:10)
- cat(s$randi(), '\\n')
+ cat(s$randi(), '\n')
}
-
diff --git a/new_R/man/syncrng-package.Rd b/new_R/man/syncrng-package.Rd
index a1b3d32..f8cfe02 100644
--- a/new_R/man/syncrng-package.Rd
+++ b/new_R/man/syncrng-package.Rd
@@ -21,6 +21,7 @@ numbers are generated using the object methods. It can also be used as a
user-defined random number generator using the strategy outlined in
.Random.user. See the examples section below.
}
+
\examples{
library(SyncRNG)
@@ -42,11 +43,10 @@ s$rand()
# [1] 6.257184e-05
}
+\references{
+URL: \url{https://github.com/GjjvdBurg/SyncRNG}
+}
\author{
Gerrit J.J. van den Burg\cr
Maintainer: Gerrit J.J. van den Burg <gertjanvandenburg@gmail.com>
}
-\references{
-URL: \url{https://github.com/GjjvdBurg/SyncRNG}
-}
-