Planned updates

A list of planned improvements for rswap

(should be switched to issue-based instead of wiki)

Features

• Parsing support for all SWAP files, not just the main file. 🛑 Required for 1.0
• Loading support for all SWAP output files 🛑 Required for 1.0
• further SWAPtools integration (plotting)
• Autocalibration / PEST integration

Sensitvivity Analysis:

• Sensitivity to an output parameter 🛑 Required for 1.0
• Multiparameter sensitivity (Equifiniality)
• GLUE?? Bayesian?

Support

• Linux support 🔄 (in progress) 🛑 Required for 1.0

Package Structure

• Make various functions such as load_swap_output() vectorized, ie. you can load the results of a whole scenario run with one command. should be rather simple.
• Store SWAP.exe path in an environmental and then copy in the SWAP exe wherever the project is? More flexible, but slower.
• perfect run_swap / run_swap_parallel interaction (swap.swp file par behavior)
• Add support for multiple variables at differing depths for autoset_output 🛑 Required for 1.0
• Add support for reading saved runs with differing output.
• Add "exact variable matching" and stop removing "RAIN" in io.R melt_all_runs() 🛑 Required for 1.0
• Renovate rswap_plot_multi() to accept any variable using the new system.
• Load data into package environment, to prevent the need for constant re-loading. add force=T option to reload 🔄 (in progress) 🛑 Required for 1.0
• Add a safety check to the parallel runs to make sure each directory is actually a SWAP setup.
• re-name plotting functions to plot_swap_xxxx() to match the other naming conventions of verb_swap_noun()
• Retrieve SWAP.exe and the hupselbrook data from the external InstallPackageSwap_4.2.0 file
• miljotools integration for MetNo data.

Documentation

• Vignettes (Sensitivity analysis)
• Climate scenario vignette / infrastructure
• Add runnable examples to all functions 🔄 (in progress)
• testing infrastructure with testthat
• Replace the readme with an Rmarkdown generated HTML file for things like interactive plots??

Error handling

• Add an error message for an incorrect observed variable name:

Error in `dplyr::left_join()` at rswap/R/stat.R:113:7:
! Join columns in `x` must be present in the data.
✖ Problem with `DATE`.

SWAPtools integration

• All the plotting functions should be imported (some might be less useful / compatible than others)
• Some of the met file data functions should be imported
• Maybe the mvg table preperation?

Finished (since wiki start)

• Parallel model runs ✔️ (v0.4.0)

• Parameter sensitivity analysis (in parallel)✔️ (v0.5.0)

Abandoned

• custom swap_exe path support ❌ Nope, see problem