aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2016-10-16 12:13:36 +0200
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2016-10-16 13:00:02 +0200
commit3fb8d4aca52c3004d52bd510e183c1d5682b5540 (patch)
treeb7ee95d5ba66f486aa0735a603d13c3f2d7b1bb2
parentupdate version and rename rst to md readme (diff)
downloadSyncRNG-3fb8d4aca52c3004d52bd510e183c1d5682b5540.tar.gz
SyncRNG-3fb8d4aca52c3004d52bd510e183c1d5682b5540.zip
update to latest version of roxygen
-rw-r--r--DESCRIPTION7
-rw-r--r--NAMESPACE7
-rw-r--r--R/SyncRNG.R5
-rw-r--r--man/SyncRNG-class.Rd5
4 files changed, 18 insertions, 6 deletions
diff --git a/DESCRIPTION b/DESCRIPTION
index f2326d1..d9444f0 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -4,9 +4,12 @@ Date: 2016-10-12
Title: A Synchronized Tausworthe RNG for R and Python
Author: Gertjan van den Burg <gertjanvandenburg@gmail.com>
Maintainer: Gertjan van den Burg <gertjanvandenburg@gmail.com>
-Depends: R (>= 3.0.0)
+Depends:
+ R (>= 3.0.0)
Description: Random number generation designed for cross-language usage.
License: file LICENSE
Imports:
methods
-Suggests: testthat
+Suggests:
+ testthat
+RoxygenNote: 5.0.1
diff --git a/NAMESPACE b/NAMESPACE
index bb2ff1a..160a4f2 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,3 +1,6 @@
-useDynLib(SyncRNG)
+# Generated by roxygen2: do not edit by hand
+
export(SyncRNG)
-import(methods)
+exportClasses(SyncRNG)
+importFrom(methods,new)
+useDynLib(SyncRNG)
diff --git a/R/SyncRNG.R b/R/SyncRNG.R
index 72156df..95e6b3e 100644
--- a/R/SyncRNG.R
+++ b/R/SyncRNG.R
@@ -6,6 +6,11 @@ library(methods)
#' @field state The current state of the RNG, should not be modified by the
#' user
#'
+#' @useDynLib SyncRNG
+#' @export SyncRNG
+#' @exportClass SyncRNG
+#' @importFrom methods new
+#'
#' @examples
#' s <- SyncRNG(seed=123456)
#' for (i in 1:10)
diff --git a/man/SyncRNG-class.Rd b/man/SyncRNG-class.Rd
index d09f331..6f6d27d 100644
--- a/man/SyncRNG-class.Rd
+++ b/man/SyncRNG-class.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/SyncRNG.R
\docType{class}
\name{SyncRNG-class}
@@ -13,7 +13,7 @@ A Reference Class for SyncRNG
\describe{
\item{\code{seed}}{The seed for the random number generator}
-\item{\code{state}}{The current state of the RNG, should not be modified by the
+\item{\code{state}}{The current state of the RNG, should not be modified by the
user}
}}
\section{Methods}{
@@ -33,5 +33,6 @@ user}
s <- SyncRNG(seed=123456)
for (i in 1:10)
cat(s$randi(), '\\n')
+
}