touch up docs; closes #69

Author: philchalmers

R/SimExtract.R

@@ -6,8 +6,10 @@
 #'
 #' @param object object returned from \code{\link{runSimulation}}
 #'
-#' @param what character indicating what information to extract. Possible inputs
-#'   include \code{'errors'} to return a \code{tibble} object containing counts of any
+#' @param what character vector indicating what information to extract, written in agnostic casing
+#'   (e.g., \code{'ERRORS'} and \code{'errors'} are equivalent).
+#'
+#'   Possible inputs include \code{'errors'}  to return a \code{tibble} object containing counts of any
 #'   error messages, \code{'warnings'} to return a \code{data.frame} object containing
 #'   counts of any warning messages, \code{'seeds'}  for the specified random number
 #'   generation seeds,  \code{'Random.seeds'} for the complete list of
@@ -16,8 +18,9 @@
 #'   \code{'error_seeds'} and \code{'warning_seeds'}
 #'   to extract the associated \code{.Random.seed} values associated with the ERROR/WARNING messages,
 #'   \code{'results'} to extract the simulation results if the option \code{store_results} was passed to
-#'   \code{\link{runSimulation}}, and \code{'filename'} and \code{'save_results_dirname'} for extracting
-#'   the saved file/directory name information (if used)
+#'   \code{\link{runSimulation}}, \code{'filename'} and \code{'save_results_dirname'} for extracting
+#'   the saved file/directory name information (if used), and \code{'design'} to extract the original
+#'   design object
 #'
 #'   Note that \code{'warning_seeds'} are not stored automatically in
 #'   simulations and require passing \code{store_warning_seeds = TRUE} to \code{\link{runSimulation}}.