updating package docs

DESCRIPTION

@@ -32,4 +32,4 @@ VignetteBuilder:
 Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1

R/R6Experiment.R

@@ -177,7 +177,7 @@ R6Experiment <- R6::R6Class(
     #' Runs R6Experiment in parallel
     #'
     #'
-    #' This function is most useful to simulate the posterior distribution for a single model in parallel in one machine. This function is not used when calibrating the model and not useful for parallelization across multiple nodes.
+    #' This function simulates the models included in the experiment, running one simulation for each row in the `policy_design` object. This function supporst local parallel execution, and assumes that each experimental variable in the `policy_design` data.frame is an input that can be set with the `model$set_input()` function.
     #'
     #' @param self experiment object
     #' @param n_cores number of cores to use

R/R6Sim.package.R

@@ -25,9 +25,7 @@
 #' This package implements the \code{\link{R6Sim}} and the \code{\link{R6Experiment}} R6 classes, providing an encapsulated object-oriented framework for simulation modeling studies.
 #'
 #'
-#' @docType package
-#' @name R6Sim.package
-NULL
+"_PACKAGE"
 
 
 

dev/config_attachment.yaml

@@ -0,0 +1,12 @@
+path.n: NAMESPACE
+path.d: DESCRIPTION
+dir.r: R
+dir.v: vignettes
+dir.t: tests
+extra.suggests: ~
+pkg_ignore: ~
+document: yes
+normalize: yes
+inside_rmd: no
+must.exist: yes
+check_if_suggests_is_installed: yes