home.md

@@ -264,7 +264,11 @@ The Visualization module provides a few basic plots to visualize the data loaded
 
 This function's parameters are similar to those in the Saving module: 
 
-`recipe` (the recipe), `archive` (the archive) and `data` (the list obtained from the Loading module) are mandatory arguments. The rest of the arguments (`calibrated_data`, `skill_metrics` and `probabilities`, and `significance`) are optional. If `significance = TRUE` (default), the statistical significance dots will be displayed in the plot, when available. It defaults to FALSE.
+`recipe` (the recipe), `archive` (the archive) and `data` (the list obtained from the Loading module) are mandatory arguments. The rest of the arguments (`calibrated_data`, `skill_metrics` and `probabilities`, and `significance`) are optional:
+- `calibrated_data`: List containing the calibrated hindcast and forecast as s2dv_cube objects.
+- `skill_metrics`: List in the format of the Skill module output, containing the skill metrics as named arrays.
+- `probabilities`: List in the format of the Skill module output, containing the 33rd and 66th percentiles.
+- If `significance = TRUE` (default), the statistical significance dots will be displayed in the plot, when available. It defaults to FALSE.
 
 plot_data() attempts to generate:
 
@@ -276,7 +280,9 @@ The three functions that plot_data() calls can also be called independently. In
 
 **plot_skill_metrics(recipe, archive, data_cube, skill_metrics, outdir, significance = F)**:
 
-Generates, for each metric in skill_metrics, a figure with one plot per time step, and saves each figure to the output directory `outdir` as `<metric>.png`
+Generates, for each metric in skill_metrics, a figure with one plot per time step, and saves each figure to the output directory `outdir` as `<metric>.png`.
+
+`data_cube` is an s2dv_cube containing the appropriate metadata, for example the hcst object from the Loading module.
 
 **plot_ensemble_mean(recipe, archive, fcst, outdir)**: Computes the forecast ensemble mean and generates a figure with one plot per time step, and saves it to the output directory `outdir` as `forecast_ensemble_mean.png`