P281424/AMR
1
0
Fork 0
mirror of https://github.com/msberends/AMR.git synced 2025-07-17 02:33:22 +02:00
Code Releases Activity

(v2.1.1.9233) chore: make all argument texts full sentences

Browse Source
This commit is contained in:
dr. M.S. (Matthijs) Berends
2025-03-31 14:53:24 +02:00
parent 63099cd81e
commit 1fdab84103
91 changed files with 720 additions and 701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
R/get_episode.R
View File

@ -30,10 +30,10 @@
#' Determine Clinical or Epidemic Episodes
#'
#' These functions determine which items in a vector can be considered (the start of) a new episode. This can be used to determine clinical episodes for any epidemiological analysis. The [get_episode()] function returns the index number of the episode per group, while the [is_new_episode()] function returns `TRUE` for every new [get_episode()] index. Both absolute and relative episode determination are supported.
#' @param x Vector of dates (class `Date` or `POSIXt`), will be sorted internally to determine episodes
#' @param episode_days Episode length in days to specify the time period after which a new episode begins, can also be less than a day or `Inf`, see *Details*
#' @param case_free_days (inter-epidemic) interval length in days after which a new episode will start, can also be less than a day or `Inf`, see *Details*
#' @param ... Ignored, only in place to allow future extensions
#' @param x Vector of dates (class `Date` or `POSIXt`), will be sorted internally to determine episodes.
#' @param episode_days Episode length in days to specify the time period after which a new episode begins, can also be less than a day or `Inf`, see *Details*.
#' @param case_free_days (inter-epidemic) interval length in days after which a new episode will start, can also be less than a day or `Inf`, see *Details*.
#' @param ... Ignored, only in place to allow future extensions.
#' @details Episodes can be determined in two ways: absolute and relative.
#'
#' 1. Absolute