Skip to content

Commit 8268d24

Browse files
authored
Merge pull request #59 from moritzketzer/patch-2
fix typo
2 parents e7a0cb4 + c0b4c56 commit 8268d24

File tree

4 files changed

+17
-18
lines changed

4 files changed

+17
-18
lines changed

DESCRIPTION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,4 @@ ByteCompile: yes
5454
LazyData: true
5555
URL: http://philchalmers.github.io/SimDesign/, https://github.com/philchalmers/SimDesign/wiki
5656
RoxygenNote: 7.3.2
57+
Encoding: UTF-8

R/runSimulation.R

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@
150150
#' @param analyse user-defined analysis function (or named list of functions)
151151
#' that acts on the data generated from
152152
#' \code{\link{Generate}} (or, if \code{generate} was omitted, can be used to generate and
153-
#' analyses the simulated data). See \code{\link{Analyse}} for details
153+
#' analyse the simulated data). See \code{\link{Analyse}} for details
154154
#'
155155
#' @param summarise optional (but strongly recommended) user-defined summary function
156156
#' from \code{\link{Summarise}} to be used to compute meta-statistical summary
@@ -174,20 +174,20 @@
174174
#' \code{Analyse()} call was a one-dimensional vector.
175175
#' For more general objects returned by \code{Analyse()}
176176
#' (such as \code{list}s), a \code{list}
177-
#' containing the results returned form \code{\link{Analyse}}.
177+
#' containing the results returned from \code{\link{Analyse}}.
178178
#' This is generally only recommended for didactic purposes because the results
179179
#' will leave out a large amount of
180180
#' information (e.g., try-errors, warning messages, saving files, etc), can
181181
#' witness memory related issues if the Analyse function returns larger objects,
182182
#' and generally is not as flexible internally. However, it may be useful
183183
#' when replications are expensive and ANOVA-based decompositions involving
184184
#' the within-condition replication information are of interest, though
185-
#' of course this can be circumvented by using \code{store_results = TRUE} or
185+
#' of course this can be circumvented by using \code{store_results = TRUE} or
186186
#' \code{save_results = TRUE} with or without a supplied \code{summarise}
187187
#' definition.
188188
#'
189189
#' Finally, there are keywords that should not be returned from this
190-
#' functions since they will cause a conflict with the aggregated simulation
190+
#' function, since they will cause a conflict with the aggregated simulation
191191
#' objects. These are currently those listed in capital letters (e.g.,
192192
#' \code{ERRORS}, \code{WARNINGS}, \code{REPLICATIONS}, etc), all of which can
193193
#' be avoided if the returned objects are not entirely capitalized
@@ -570,12 +570,11 @@
570570
#' If the input is a vector then \code{\link{set.seed}} or
571571
#' \code{\link{clusterSetRNGStream}} for each condition will be called, respectively.
572572
#' If a list is provided then these
573-
#' numbers must have been generated from \code{\link{gen_seeds}} with the argument
574-
#' \code{CMRG.seed} used to specify the initial. The list approach ensures random number
575-
#' generation independence across conditions and replications, while the vector input
576-
#' ensures independence within the replications per conditions but not necessarily
577-
#' across conditions. Default randomly generates seeds within the
578-
#' range 1 to 2147483647 for each condition via \code{\link{gen_seeds}}
573+
#' numbers must have been generated from \code{\link{genSeeds}}. The list approach
574+
#' ensures random number generation independence across conditions and replications,
575+
#' while the vector input ensures independence within the replications per conditions
576+
#' but not necessarily across conditions. Default randomly generates seeds within the
577+
#' range 1 to 2147483647 for each condition via \code{\link{genSeeds}}
579578
#'
580579
#' @param progress logical; display a progress bar (using the \code{pbapply} package)
581580
#' for each simulation condition?

man/runSimulation.Rd

Lines changed: 5 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tests/tests/test-03-array.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ test_that('array', {
4646
expect_true(nrow(results) == 9)
4747

4848
# define initial seed (do this only once to keep it constant!)
49-
# iseed <- gen_seeds()
49+
# iseed <- genSeeds()
5050
iseed <- 554184288
5151

5252
### On cluster submission, the active array ID is obtained via getArrayID(),
@@ -75,7 +75,7 @@ test_that('array', {
7575
# evaluations and combine when complete
7676
Design5 <- expandDesign(Design, 5)
7777

78-
# iseed <- gen_seeds()
78+
# iseed <- genSeeds()
7979
iseed <- 554184288
8080

8181
# arrayID <- getArrayID(type = 'slurm')

0 commit comments

Comments
 (0)