Skip to content

Commit

Permalink
Remove awkward line breaks
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmbaazam committed Nov 1, 2023
1 parent c14af36 commit c277d5c
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 22 deletions.
6 changes: 3 additions & 3 deletions R/checks.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
#' @param reports A data frame with either:
#' * a minimum of two columns: `date` and `confirm`, if to be
#' used by [estimate_infections()] or [estimate_truncation()], or
#' * a minimum of three columns: `date`, `primary`, and `secondary`, if
#' to be used by
#' [estimate_secondary()].
#' * a minimum of three columns: `date`, `primary`, and `secondary`, if to be
#' used by [estimate_secondary()].
#' @param model The EpiNow2 model to be used. Either
#' "estimate_infections", "estimate_truncation", or "estimate_secondary".
#' This is used to determine which checks to perform on the data input.
#' @importFrom checkmate assert_data_frame assert_date assert_names
#' assert_numeric
#' @importFrom rlang arg_match
#' @return Called for its side effects.
#' @author James M. Azam
#' @keywords internal
Expand Down
15 changes: 7 additions & 8 deletions R/estimate_secondary.R
Original file line number Diff line number Diff line change
Expand Up @@ -253,14 +253,13 @@ estimate_secondary <- function(reports,
#'
#' @seealso estimate_secondary
#' @return A `<secondary_opts>` object of binary options summarising secondary
#' model used in
#' `estimate_secondary()`. Options returned are `cumulative` (should the
#' secondary report be cumulative), `historic` (should a convolution of primary
#' reported cases be used to predict secondary reported cases),
#' `primary_hist_additive` (should the historic convolution of primary reported
#' cases be additive or subtractive), `current` (should currently observed
#' primary reported cases contribute to current secondary reported cases),
#' `primary_current_additive` (should current primary reported cases be
#' model used in `estimate_secondary()`. Options returned are `cumulative`
#' (should the secondary report be cumulative), `historic` (should a
#' convolution of primary reported cases be used to predict secondary reported
#' cases), `primary_hist_additive` (should the historic convolution of primary
#' reported cases be additive or subtractive), `current` (should currently
#' observed primary reported cases contribute to current secondary reported
#' cases), `primary_current_additive` (should current primary reported cases be
#' additive or subtractive).
#'
#' @export
Expand Down
5 changes: 2 additions & 3 deletions man/check_reports_valid.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 7 additions & 8 deletions man/secondary_opts.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c277d5c

Please sign in to comment.