Update power docs

openpharma · Nov 8, 2023 · 918a2b2 · 918a2b2
1 parent f1453a7
commit 918a2b2
Show file tree

Hide file tree

Showing 12 changed files with 132 additions and 120 deletions.
diff --git a/R/graph_calculate_power.R b/R/graph_calculate_power.R
@@ -46,14 +46,19 @@
 #'   matrix of test results for the simulation, resulting in a `sim_n` length
 #'   vector. The mean of this vector is returned as "Probability of success"
 #'
-#' @return A list with five elements
-#'   * power_local - rejection proportion for each hypothesis individually
-#'   * power_expected - average number of hypotheses rejected in a single
-#'   simulation
-#'   * power_at_least_1 - proportion of simulations which reject any hypothesis
-#'   * power_all - proportion of simulations which reject all hypotheses
-#'   * power_success - proportion of simulations which reject any of the
+#' @return A list with three elements
+#'   * inputs - A list of input parameters
+#'   * power - A list of measures of how often hypotheses are rejected
+#'       * power_local - Rejection proportion for each hypothesis individually
+#'       * power_expected - Average number of hypotheses rejected in a single
+#'       simulation
+#'       * power_at_least_1 - Proportion of simulations which reject any
+#'       hypothesis
+#'       * power_all - Proportion of simulations which reject all hypotheses
+#'       * power_success - Proportion of simulations which reject any of the
 #'   hypotheses specified in `sim_success`
+#'   * details - An optional list of datasets showing simulated p-values and
+#'   results for each simulation
 #'
 #' @export
 #'

diff --git a/man/adjust_p.Rd b/man/adjust_p.Rd
diff --git a/man/adjusted-weights.Rd b/man/adjusted-weights.Rd
diff --git a/man/calc-test_values.Rd b/man/calc-test_values.Rd
diff --git a/man/example-graphs.Rd b/man/example-graphs.Rd
diff --git a/man/graph_calculate_power.Rd b/man/graph_calculate_power.Rd
diff --git a/man/graph_create.Rd b/man/graph_create.Rd
diff --git a/man/graph_generate_weights.Rd b/man/graph_generate_weights.Rd
diff --git a/man/graph_update.Rd b/man/graph_update.Rd
diff --git a/man/testing-fast.Rd b/man/testing-fast.Rd