Create YAML formatted metadata file listing states without wastewater data, states with insufficient wastewater data, and states for which we used the hospital admissions only model.

Create YAML formatted metadata file listing states without wastewater data, states with insufficient wastewater data, and states for which we used the hospital admissions only model.

Usage

get_metadata_yaml(
  data_diagnostics_df,
  hosp_only_states,
  exclude_states,
  output_dir = NULL,
  prod_run = FALSE
)

Arguments

data_diagnostics_df

Data frame of data diagnostics by location

hosp_only_states

States for which we chose to use the hospitalization only model, as a vector with states coded identically to how they are in the location column of full_diagnostics_df

exclude_states

States for which we chose to not submit a forecast for this week, as a vector with states coded identically to how they are in the location columnd of `full_diagnostics_df

output_dir

Path to a directory in which to save the metadata table. Only used if prod_run = TRUE. Default NULL.

prod_run

Is this a run for publication / production? If so, the output will be saved in an appropriate location as a .tsv. Boolean, default FALSE

Value

The metadata to be saved, as a list.