Docs: update package docs with Ising model information

man-roxygen/generate_model.R

@@ -7,7 +7,7 @@
 #' [powerly::powerly()].
 #'
 #' @param type Character string representing the type of true model. Possible
-#' values are `"ggm"` (the default).
+#' values are `"ggm"` (the default) or `"ising"`.
 #'
 #' @param ... Required arguments used for the generation of the true model. See
 #' the **True Models** section of [powerly::powerly()] for the arguments

man-roxygen/powerly.R

@@ -20,7 +20,7 @@
 #' candidate range.
 #'
 #' @param model A character string representing the type of true model to find a
-#' sample size for. Possible values are `"ggm"` (the default).
+#' sample size for. Possible values are `"ggm"` (the default) or `"ising"`.
 #'
 #' @param ... Required arguments used for the generation of the true model. See
 #' the **True Models** section for the arguments required for each true model.
@@ -142,6 +142,15 @@
 #'     - Yin, J., and Li, H. (2011). A sparse conditional gaussian graphical model for analysis of genetical genomics data. *The annals of applied statistics*, 5(4), 2630.
 #' - supported performance measures: `sen`, `spe`, `mcc`, `rho`
 #'
+#' **Ising Model**
+#' - type: cross-sectional
+#' - symbol: `ising`
+#' - `...` arguments for generating true models:
+#'   - `nodes`: A single positive integer representing the number of nodes in the network (e.g., `10`).
+#'   - `density`: A single numerical value indicating the density of the network (e.g., `0.4`).
+#'   - `positive`: A single numerical value representing the proportion of positive edges in the network (e.g., `0.9` for 90% positive edges).
+#' - supported performance measures: `sen`, `spe`, `mcc`, `rho`
+#'
 #' @section Performance Measures:
 #'
 #' | **Performance Measure**  | **Symbol** | **Lower**   | **Upper**  |