The current production package cfaforecastrenewalww is missing a lot of documentation. There is a plan to separate the modeling functionality from the production pipeline functionality. This issue is to improve the documentation on the modeling components, which include:
utils.R
process_model_outputs.R (with a refactor using components from wweval)
certain parts of plots.R
very immediate pre-modeling parts of pre_processing.R
fit_model.R
Requirements
[ ] documentation should be sufficient for an external user, complete with examples
[ ] all documentation should have type notes for function arguments and outputs
Problem
The current production package
cfaforecastrenewalwwis missing a lot of documentation. There is a plan to separate the modeling functionality from the production pipeline functionality. This issue is to improve the documentation on the modeling components, which include:utils.Rprocess_model_outputs.R(with a refactor using components fromwweval)plots.Rpre_processing.Rfit_model.RRequirements