docs(aep2stage, stage2aep): remove \dontrun{}, document ties warning

(bootstrap_vfc): remove \dontrun{}, clarify GEV/LP3 examples

docs(rfa_simulate): fix Expected-mode parameter set, document runtime

Author: danmcgraw94

R/bootstrap_vfc.R

@@ -29,13 +29,15 @@
 #'                                 dist = "LP3",
 #'                                 ERL = jmd_vfc_parameters$erl)
 #'
+#' # GEV Example with parent distribution parameters
 #' gev_example <- c(3.0, 1.0, -0.1)
 #' gev_samples <- bootstrap_vfc(gev_example,
 #'                               dist = "GEV",
 #'                               ERL = 200,
 #'                               Nboots = 5000)
 #' hist(gev_samples$params[,1])
 #'
+#' # LP3 Example with parent distribution parameters
 #' lp3_example <- c(3.5, 0.22, 0.1)
 #' lp3_samples <- bootstrap_vfc(lp3_example,
 #'                               dist = "LP3",

R/flow_frequency_sampler.R

@@ -31,7 +31,10 @@
 #' params <- c(4.85, 0.39, -0.15)
 #' result <- flow_frequency_sampler(params, freq_dist = "LP3",
 #'                                  Nbin = 20, Mevent = 500)
+#' # Dimensions of result
 #' dim(result$flow)  # 500 x 20
+#'
+#' # Distribution of Sampled Flows
 #' hist(result$flow)
 
 flow_frequency_sampler <- function(bestfit_params, freq_dist = "LP3",

R/rfa_simulate.R

@@ -143,6 +143,10 @@
 #'
 #' @examples
 #' \dontrun{
+#' # Not run: Expected and Median modes take ~15s; Full uncert
+#' # runs ~10,000 parameter realizations and takes 3-4 hours on a
+#' # typical machine.
+#'
 #' # --- Setup ---
 #' hydros <- hydrograph_setup(jmd_hydro_apr1999, jmd_hydro_jun1965,
 #'                            jmd_hydro_may1955, jmd_hydro_pmf,
@@ -151,7 +155,7 @@
 #' # --- Expected only (default) ---
 #' results_exp <- rfa_simulate(
 #'   sim_type       = "expected",
-#'   bestfit_params = jmd_vfc_parameters,
+#'   bestfit_params = jmd_bf_parameter_sets,
 #'   stage_ts       = jmd_wy1980_stage,
 #'   seasonality    = jmd_seasonality$relative_frequency,
 #'   hydrographs    = hydros,
@@ -162,7 +166,7 @@
 #' # --- Median only ---
 #' results_med <- rfa_simulate(
 #'   sim_type       = "median",
-#'   bestfit_params = jmd_vfc_parameters,
+#'   bestfit_params = jmd_bf_parameter_sets,
 #'   stage_ts       = jmd_wy1980_stage,
 #'   seasonality    = jmd_seasonality$relative_frequency,
 #'   hydrographs    = hydros,
@@ -173,16 +177,14 @@
 #' # --- Full uncertainty (parallelized) ---
 #' results_full <- rfa_simulate(
 #'   sim_type       = "full",
-#'   bestfit_params = jmd_vfc_parameters,
+#'   bestfit_params = jmd_bf_parameter_sets,
 #'   stage_ts       = jmd_wy1980_stage,
 #'   seasonality    = jmd_seasonality$relative_frequency,
 #'   hydrographs    = hydros,
 #'   resmodel       = jmd_resmodel,
 #'   Ncores         = 4,
 #'   sim_name       = "jmd"
 #' )
-#'
-
 #' }
 rfa_simulate <- function(sim_type = "expected", bestfit_params, dist = "LP3",
                          stage_ts, seasonality, hydrographs, resmodel,