run.null.models: Generate null models based on mean values

View source: R/dfmip.R

run.null.modelsR Documentation

Generate null models based on mean values

Description

Create simple null models for comparison

Usage

run.null.models(
  forecast.targets,
  forecasts.df,
  forecast.distributions,
  human.data,
  week.id,
  weekinquestion,
  n.draws,
  point.estimate,
  analysis.locations,
  mosq.data = NA,
  population.df = NA,
  model.name = "NULL.MODELS"
)

Arguments

forecast.targets

See dfmip.forecast

forecasts.df

See dfmip.forecast

forecast.distributions

See dfmip.forecast

human.data

See dfmip.forecast

week.id

See dfmip.forecast

weekinquestion

See dfmip.forecast

n.draws

The number of draws for the forecast distributions. Should be 1 if a point estimate is used, otherwise should be a large enough number to adequately represent the variation in the underlying data

point.estimate

Whether a single point estimate should be returned for forecast distributions representing the mean value. Otherwise past years are sampled at random.

analysis.locations

locations to include in the analysis. This may include locations with no human cases that would otherwise be dropped from the modeling.

mosq.data

Only required if a mosquito output is among the forecast targets. See dfmip.forecast

population.df

A data frame with locations (counties) and their populations. A column labeled SPATIAL should contain the county/location information, while population should be in a TOTAL_POPULATION column. Only required if incidence calculations are desired.

model.name

The name of the model to use in forecasts.df and forecast.distributions

Value

A list consisting of a data frame with forecast results and a list of forecast distributions


akeyel/dfmip documentation built on Sept. 3, 2022, 1:26 a.m.