These functions determine which items in a vector can be considered (the start of) a new episode, based on the argument episode_days. 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 values TRUE/FALSE to indicate whether an item in a vector is the start of a new episode.
Arguments
- x
vector of dates (class
DateorPOSIXt), will be sorted internally to determine episodes- episode_days
required episode length in days, can also be less than a day or
Inf, see Details- ...
ignored, only in place to allow future extensions
Details
Dates are first sorted from old to new. The oldest date will mark the start of the first episode. After this date, the next date will be marked that is at least episode_days days later than the start of the first episode. From that second marked date on, the next date will be marked that is at least episode_days days later than the start of the second episode which will be the start of the third episode, and so on. Before the vector is being returned, the original order will be restored.
The first_isolate() function is a wrapper around the is_new_episode() function, but is more efficient for data sets containing microorganism codes or names and allows for different isolate selection methods.
The dplyr package is not required for these functions to work, but these functions do support variable grouping and work conveniently inside dplyr verbs such as filter(), mutate() and summarise().
Examples
# `example_isolates` is a data set available in the AMR package.
# See ?example_isolates
df <- example_isolates[sample(seq_len(2000), size = 200), ]
get_episode(df$date, episode_days = 60) # indices
#> [1] 48 59 29 38 17 25 17 65 4 35 7 6 23 10 54 12 27 58 52 44 11 61 29 42 8
#> [26] 12 45 30 11 21 14 60 27 28 14 54 17 30 61 39 8 53 34 65 1 5 45 47 51 18
#> [51] 41 36 59 59 59 47 4 11 1 59 42 2 30 38 67 46 18 34 8 63 40 6 22 60 25
#> [76] 68 11 23 30 16 37 40 31 43 23 21 27 21 57 46 54 35 60 44 1 43 45 2 37 59
#> [101] 67 67 68 32 26 1 36 13 57 51 49 45 38 19 62 6 69 40 9 66 14 55 40 61 4
#> [126] 28 15 58 63 65 39 49 31 11 26 65 27 13 21 68 50 14 3 4 42 24 20 22 59 61
#> [151] 64 16 60 48 51 29 7 25 41 16 48 33 66 67 61 63 43 18 59 2 39 49 64 14 51
#> [176] 52 10 40 4 61 6 30 4 56 10 59 68 31 62 65 60 1 24 65 31 2 22 15 5 53
is_new_episode(df$date, episode_days = 60) # TRUE/FALSE
#> [1] FALSE FALSE TRUE FALSE FALSE TRUE TRUE TRUE TRUE TRUE TRUE TRUE
#> [13] TRUE FALSE TRUE TRUE FALSE TRUE TRUE TRUE FALSE FALSE FALSE FALSE
#> [25] TRUE FALSE FALSE TRUE FALSE TRUE FALSE TRUE TRUE FALSE FALSE FALSE
#> [37] FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE TRUE FALSE
#> [49] FALSE TRUE TRUE FALSE FALSE FALSE FALSE TRUE FALSE TRUE FALSE TRUE
#> [61] FALSE TRUE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE
#> [73] TRUE FALSE FALSE FALSE FALSE FALSE FALSE TRUE TRUE FALSE FALSE FALSE
#> [85] FALSE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE
#> [97] FALSE FALSE FALSE FALSE FALSE TRUE FALSE TRUE FALSE TRUE TRUE TRUE
#> [109] TRUE FALSE TRUE FALSE FALSE TRUE FALSE FALSE TRUE TRUE TRUE FALSE
#> [121] TRUE TRUE FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE
#> [133] FALSE FALSE TRUE FALSE FALSE FALSE FALSE TRUE TRUE FALSE TRUE FALSE
#> [145] TRUE FALSE TRUE FALSE FALSE TRUE FALSE FALSE FALSE FALSE TRUE FALSE
#> [157] FALSE FALSE FALSE FALSE TRUE TRUE TRUE FALSE FALSE TRUE TRUE FALSE
#> [169] FALSE FALSE TRUE FALSE TRUE FALSE FALSE FALSE TRUE FALSE FALSE FALSE
#> [181] FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE TRUE FALSE FALSE FALSE
#> [193] TRUE FALSE TRUE FALSE FALSE TRUE FALSE TRUE
# filter on results from the third 60-day episode only, using base R
df[which(get_episode(df$date, 60) == 3), ]
#> # A tibble: 1 × 46
#> date patient age gender ward mo PEN OXA FLC AMX
#> <date> <chr> <dbl> <chr> <chr> <mo> <rsi> <rsi> <rsi> <rsi>
#> 1 2002-06-22 FD8039 75 F ICU B_ESCHR_COLI R NA NA NA
#> # … with 36 more variables: AMC <rsi>, AMP <rsi>, TZP <rsi>, CZO <rsi>,
#> # FEP <rsi>, CXM <rsi>, FOX <rsi>, CTX <rsi>, CAZ <rsi>, CRO <rsi>,
#> # GEN <rsi>, TOB <rsi>, AMK <rsi>, KAN <rsi>, TMP <rsi>, SXT <rsi>,
#> # NIT <rsi>, FOS <rsi>, LNZ <rsi>, CIP <rsi>, MFX <rsi>, VAN <rsi>,
#> # TEC <rsi>, TCY <rsi>, TGC <rsi>, DOX <rsi>, ERY <rsi>, CLI <rsi>,
#> # AZM <rsi>, IPM <rsi>, MEM <rsi>, MTR <rsi>, CHL <rsi>, COL <rsi>,
#> # MUP <rsi>, RIF <rsi>
# the functions also work for less than a day, e.g. to include one per hour:
get_episode(c(
Sys.time(),
Sys.time() + 60 * 60
),
episode_days = 1 / 24
)
#> [1] 1 2
# \donttest{
if (require("dplyr")) {
# is_new_episode() can also be used in dplyr verbs to determine patient
# episodes based on any (combination of) grouping variables:
df %>%
mutate(condition = sample(
x = c("A", "B", "C"),
size = 200,
replace = TRUE
)) %>%
group_by(condition) %>%
mutate(new_episode = is_new_episode(date, 365)) %>%
select(patient, date, condition, new_episode)
}
#> # A tibble: 200 × 4
#> # Groups: condition [3]
#> patient date condition new_episode
#> <chr> <date> <chr> <lgl>
#> 1 660761 2013-03-05 B FALSE
#> 2 992282 2015-11-17 C FALSE
#> 3 445249 2008-06-10 A FALSE
#> 4 566040 2010-12-14 B FALSE
#> 5 425433 2005-07-11 A FALSE
#> 6 92F410 2007-03-26 B FALSE
#> 7 B338BC 2005-07-02 B FALSE
#> 8 423709 2017-01-30 B FALSE
#> 9 390178 2002-08-28 B FALSE
#> 10 16F0F7 2010-01-17 B FALSE
#> # … with 190 more rows
if (require("dplyr")) {
df %>%
group_by(ward, patient) %>%
transmute(date,
patient,
new_index = get_episode(date, 60),
new_logical = is_new_episode(date, 60)
)
}
#> # A tibble: 200 × 5
#> # Groups: ward, patient [185]
#> ward date patient new_index new_logical
#> <chr> <date> <chr> <dbl> <lgl>
#> 1 Clinical 2013-03-05 660761 1 TRUE
#> 2 ICU 2015-11-17 992282 1 TRUE
#> 3 Clinical 2008-06-10 445249 1 TRUE
#> 4 ICU 2010-12-14 566040 1 TRUE
#> 5 Clinical 2005-07-11 425433 1 TRUE
#> 6 Clinical 2007-03-26 92F410 1 TRUE
#> 7 Clinical 2005-07-02 B338BC 1 TRUE
#> 8 Clinical 2017-01-30 423709 1 TRUE
#> 9 Clinical 2002-08-28 390178 1 TRUE
#> 10 Clinical 2010-01-17 16F0F7 1 TRUE
#> # … with 190 more rows
if (require("dplyr")) {
df %>%
group_by(ward) %>%
summarise(
n_patients = n_distinct(patient),
n_episodes_365 = sum(is_new_episode(date, episode_days = 365)),
n_episodes_60 = sum(is_new_episode(date, episode_days = 60)),
n_episodes_30 = sum(is_new_episode(date, episode_days = 30))
)
}
#> # A tibble: 3 × 5
#> ward n_patients n_episodes_365 n_episodes_60 n_episodes_30
#> <chr> <int> <int> <int> <int>
#> 1 Clinical 111 14 55 71
#> 2 ICU 56 12 34 41
#> 3 Outpatient 18 7 14 17
if (require("dplyr")) {
# grouping on patients and microorganisms leads to the same
# results as first_isolate() when using 'episode-based':
x <- df %>%
filter_first_isolate(
include_unknown = TRUE,
method = "episode-based"
)
y <- df %>%
group_by(patient, mo) %>%
filter(is_new_episode(date, 365)) %>%
ungroup()
identical(x, y)
}
#> Including isolates from ICU.
#> [1] TRUE
if (require("dplyr")) {
# but is_new_episode() has a lot more flexibility than first_isolate(),
# since you can now group on anything that seems relevant:
df %>%
group_by(patient, mo, ward) %>%
mutate(flag_episode = is_new_episode(date, 365)) %>%
select(group_vars(.), flag_episode)
}
#> # A tibble: 200 × 4
#> # Groups: patient, mo, ward [193]
#> patient mo ward flag_episode
#> <chr> <mo> <chr> <lgl>
#> 1 660761 B_STRPT_DYSG Clinical TRUE
#> 2 992282 B_STRPT_PNMN ICU TRUE
#> 3 445249 B_STPHY_CONS Clinical TRUE
#> 4 566040 B_STPHY_CONS ICU TRUE
#> 5 425433 B_ESCHR_COLI Clinical TRUE
#> 6 92F410 B_PROTS_MRBL Clinical TRUE
#> 7 B338BC B_ENTRC Clinical TRUE
#> 8 423709 B_ESCHR_COLI Clinical TRUE
#> 9 390178 B_STRPT_SLVR Clinical TRUE
#> 10 16F0F7 B_STPHY_AURS Clinical TRUE
#> # … with 190 more rows
# }