... | @@ -216,18 +216,17 @@ save_data() serves as the main wrapper function for this module.`recipe` (the re |
... | @@ -216,18 +216,17 @@ save_data() serves as the main wrapper function for this module.`recipe` (the re |
|
|
|
|
|
Including the `calibrated_data` parameter will save the calibrated datasets. Including `skill_metrics` and `probabilities` will save the skill metrics and the percentiles and probability bins, respectively.
|
|
Including the `calibrated_data` parameter will save the calibrated datasets. Including `skill_metrics` and `probabilities` will save the skill metrics and the percentiles and probability bins, respectively.
|
|
|
|
|
|
Therefore, all the data can be saved at once:
|
|
```R
|
|
|
|
# Therefore, all the data can be saved at once:
|
|
|
|
save_data(recipe, archive, data, calibrated_data, skill_metrics, probabilities)
|
|
|
|
|
|
`save_data(recipe, archive, data, calibrated_data, skill_metrics, probabilities)`
|
|
# Or, one can choose to save only some of it. For example,
|
|
|
|
# saving the calibrated hcst/fcst and corresponding observations only:
|
|
|
|
save_data(recipe, archive, data, calibrated_data = calibrated_data)
|
|
|
|
|
|
Or, one can choose to save only some of it. For example,
|
|
# Or saving the skill metrics only:
|
|
saving the calibrated hcst/fcst and corresponding observations only:
|
|
save_data(recipe, archive, data, skill_metrics = skill_metrics)
|
|
|
|
```
|
|
`save_data(recipe, archive, data, calibrated_data = calibrated_data)`
|
|
|
|
|
|
|
|
Or saving the skill metrics only:
|
|
|
|
|
|
|
|
`save_data(recipe, archive, data, skill_metrics = skill_metrics)`
|
|
|
|
|
|
|
|
### The structure of the output directory
|
|
### The structure of the output directory
|
|
|
|
|
... | @@ -256,6 +255,33 @@ All of the skill metrics with (time, latitude, longitude) dimensions are saved t |
... | @@ -256,6 +255,33 @@ All of the skill metrics with (time, latitude, longitude) dimensions are saved t |
|
|
|
|
|
The file containing the requested quantiles is named `<var>-percentiles_month<mm>.nc`. For each year of the hindcast period there is also a file named `<var>-probs_<yyyymmdd>.nc` containing the probability bins.
|
|
The file containing the requested quantiles is named `<var>-percentiles_month<mm>.nc`. For each year of the hindcast period there is also a file named `<var>-probs_<yyyymmdd>.nc` containing the probability bins.
|
|
|
|
|
|
|
|
## Visualization module
|
|
|
|
|
|
|
|
The Visualization module provides a few basic plots to visualize the data loaded and computed using the previous modules.
|
|
|
|
|
|
|
|
|
|
|
|
**plot_data()** is the main wrapper function for this module. It extracts the output directory from the recipe and creates a subdirectory named `plots/`.
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
plot_data() attempts to generate:
|
|
|
|
|
|
|
|
- Plots of all the skill metrics provided in `skill_metrics`.
|
|
|
|
- A plot of the forecast ensemble mean, if a forecast has been provided. If `calibrated_data` is NULL, the uncalibrated forecast will be used.
|
|
|
|
- A Most Likely Terciles plot, if a forecast has been provided and the `probabilities` include the terciles (percentiles 33 and 66).
|
|
|
|
|
|
|
|
The three independent functions that plot_data() calls can also be called independently:
|
|
|
|
|
|
|
|
**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`
|
|
|
|
|
|
|
|
**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`
|
|
|
|
|
|
|
|
**plot_most_likely_terciles(recipe, archive, fcst, percentiles, outdir)**: Computes the forecast tercile probability bins with respect to the terciles provided in 'percentiles', then generates a figure with one plot per time step and saves it to the directory `outdir` as `forecast_most_likely_terciles.png`
|
|
|
|
|
|
## **FAQ**
|
|
## **FAQ**
|
|
|
|
|
|
**Can a new metric/method/module/functionality be added to the ESS Verification Suite?**
|
|
**Can a new metric/method/module/functionality be added to the ESS Verification Suite?**
|
... | | ... | |