|
150 | 150 | #' @param analyse user-defined analysis function (or named list of functions)
|
151 | 151 | #' that acts on the data generated from
|
152 | 152 | #' \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 |
154 | 154 | #'
|
155 | 155 | #' @param summarise optional (but strongly recommended) user-defined summary function
|
156 | 156 | #' from \code{\link{Summarise}} to be used to compute meta-statistical summary
|
|
174 | 174 | #' \code{Analyse()} call was a one-dimensional vector.
|
175 | 175 | #' For more general objects returned by \code{Analyse()}
|
176 | 176 | #' (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}}. |
178 | 178 | #' This is generally only recommended for didactic purposes because the results
|
179 | 179 | #' will leave out a large amount of
|
180 | 180 | #' information (e.g., try-errors, warning messages, saving files, etc), can
|
181 | 181 | #' witness memory related issues if the Analyse function returns larger objects,
|
182 | 182 | #' and generally is not as flexible internally. However, it may be useful
|
183 | 183 | #' when replications are expensive and ANOVA-based decompositions involving
|
184 | 184 | #' 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 |
186 | 186 | #' \code{save_results = TRUE} with or without a supplied \code{summarise}
|
187 | 187 | #' definition.
|
188 | 188 | #'
|
189 | 189 | #' 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 |
191 | 191 | #' objects. These are currently those listed in capital letters (e.g.,
|
192 | 192 | #' \code{ERRORS}, \code{WARNINGS}, \code{REPLICATIONS}, etc), all of which can
|
193 | 193 | #' be avoided if the returned objects are not entirely capitalized
|
|
570 | 570 | #' If the input is a vector then \code{\link{set.seed}} or
|
571 | 571 | #' \code{\link{clusterSetRNGStream}} for each condition will be called, respectively.
|
572 | 572 | #' 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}} |
579 | 578 | #'
|
580 | 579 | #' @param progress logical; display a progress bar (using the \code{pbapply} package)
|
581 | 580 | #' for each simulation condition?
|
|
0 commit comments