Get a table that records notes on data characteristics and model choices for individual locations, e.g. the absence of recent wastewater observations or the decision to publish the hospital admissions only model
Source:R/get_output_metadata.R
get_location_notes_table.Rd
Get a table that records notes on data characteristics and model choices for individual locations, e.g. the absence of recent wastewater observations or the decision to publish the hospital admissions only model
Usage
get_location_notes_table(
full_diagnostics_df,
hosp_only_states,
exclude_states,
output_dir = NULL,
prod_run = FALSE
)
Arguments
- full_diagnostics_df
Data frame of data diagnostics by locations.
- 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 offull_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 offull_diagnostics_df
- output_dir
Path to a directory in which to save the metadata table. Only used if
prod_run = TRUE
. DefaultNULL
.- 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 table of information as a tibble::tibble()
.