-eval_design_mc() Add example of error bars

tylermorganwall · Mar 25, 2024 · 6bfc5e7 · 6bfc5e7
1 parent fb21b67
commit 6bfc5e7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/R/eval_design_mc.R b/R/eval_design_mc.R
@@ -147,6 +147,13 @@
 #'eval_design_mc(designcoffee, nsim = 100, glmfamily = "gaussian")
 #'}
 #'if(skpr:::run_documentation()) {
+#'#We can also add error bars on the Monte Carlo power values by setting
+#'#`detailedoutput = TRUE` (which will print out other information as well).
+#'#We can set the confidence via the `advancedoptions` argument.
+#'eval_design_mc(designcoffee, nsim = 100, glmfamily = "gaussian",
+#'               detailedoutput = TRUE, advancedoptions = list(ci_error_conf  = 0.8))
+#'}
+#'if(skpr:::run_documentation()) {
 #'#We see here we generate approximately the same parameter powers as we do
 #'#using the normal approximation in eval_design. Like eval_design, we can also change
 #'#effectsize to produce a different signal-to-noise ratio:

diff --git a/man/eval_design_mc.Rd b/man/eval_design_mc.Rd