cmu-delphi / epipredict

Tools for building predictive models in epidemiology.
https://cmu-delphi.github.io/epipredict/
Other
8 stars 8 forks source link

Clarify documentation for and sanity-check `nafill_buffer` usage #320

Open brookslogan opened 2 months ago

brookslogan commented 2 months ago

The args list help entries for the canned forecasters, including ones that don't use lags, is:

nafill_buffer: At predict time, recent values of the training data are
          used to create a forecast. However, these can be 'NA' due to,
          e.g., data latency issues. By default, any missing values
          will get filled with less recent data. Setting this value to
          'NULL' will result in 1 extra recent row (beyond those
          required for lag creation) to be used. Note that we require
          at least 'min(lags)' rows of recent data per 'geo_value' to
          create a prediction. For this reason, setting 'nafill_buffer
          < min(lags)' will be treated as _additional_ allowed recent
          data rather than the total amount of recent data to examine.

This confused me, and I think there may be some implementation bug(s).

Requests:

brookslogan commented 2 months ago

Maybe we don't have to address this, if the related code and documentation is removed as part of #293.