Skip to content

Commit

Permalink
Add some flavor text on exclusions
Browse files Browse the repository at this point in the history
  • Loading branch information
zsusswein committed Sep 10, 2024
1 parent 856fd58 commit 717858a
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions R/exclusions.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
#' Convert case counts in matching rows to NA
#'
#' NAs are skipped in model fitting by EpiNow2, so matched rows are excluded
#' from the model likelihood.
#' Mark selected points to be ignored in model fitting. This manual selection
#' occurs externally to the pipeline and is passed to the pipeline in an
#' exclusions file read with [read_exclusions()]. Mechanically, the exclusions
#' are applied by converting specified points to NAs in the dataset. NAs are
#' skipped in model fitting by EpiNow2, so matched rows are excluded from the
#' model likelihood.
#'
#' @param cases A dataframe returned by [read_data()]
#' @param exclusions A dataframe returned by [read_exclusions()]
Expand Down

0 comments on commit 717858a

Please sign in to comment.