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 TRUE for every new get_episode() index, and is thus equal to !duplicated(get_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
The functions get_episode() and is_new_episode() differ in this way when setting episode_days to 365:
| person_id | date | get_episode() | is_new_episode() |
| A | 2019-01-01 | 1 | TRUE |
| A | 2019-03-01 | 1 | FALSE |
| A | 2021-01-01 | 2 | TRUE |
| B | 2008-01-01 | 1 | TRUE |
| B | 2008-01-01 | 1 | FALSE |
| C | 2020-01-01 | 1 | TRUE |
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 episode 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 = 100), ]
get_episode(df$date, episode_days = 60) # indices
#> [1] 5 27 24 19 46 12 45 39 38 2 2 31 20 24 36 49 47 22 49 34 23 49 51 9 11
#> [26] 22 1 17 13 5 43 45 27 6 19 7 10 23 45 32 12 9 4 34 26 30 21 48 47 36
#> [51] 41 44 1 23 14 21 11 29 9 28 8 50 48 42 32 36 15 38 6 2 32 25 44 18 3
#> [76] 16 42 35 9 29 36 17 43 33 12 10 40 43 29 16 11 4 19 37 23 41 21 46 8 51
is_new_episode(df$date, episode_days = 60) # TRUE/FALSE
#> [1] TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE TRUE FALSE TRUE
#> [13] TRUE FALSE TRUE TRUE TRUE TRUE FALSE TRUE TRUE FALSE TRUE TRUE
#> [25] TRUE FALSE TRUE TRUE TRUE FALSE TRUE FALSE FALSE TRUE FALSE TRUE
#> [37] TRUE FALSE FALSE TRUE FALSE FALSE TRUE FALSE TRUE TRUE TRUE TRUE
#> [49] FALSE FALSE TRUE TRUE FALSE FALSE TRUE FALSE FALSE TRUE FALSE TRUE
#> [61] TRUE TRUE FALSE TRUE FALSE FALSE TRUE FALSE FALSE FALSE FALSE TRUE
#> [73] FALSE TRUE TRUE TRUE FALSE TRUE FALSE FALSE FALSE FALSE FALSE TRUE
#> [85] FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE FALSE
#> [97] FALSE FALSE FALSE FALSE
# 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 AMC
#> <date> <chr> <dbl> <chr> <chr> <mo> <sir> <sir> <sir> <sir> <sir>
#> 1 2002-06-18 012595 30 M ICU B_CRYNB I NA NA NA NA
#> # … with 35 more variables: AMP <sir>, TZP <sir>, CZO <sir>, FEP <sir>,
#> # CXM <sir>, FOX <sir>, CTX <sir>, CAZ <sir>, CRO <sir>, GEN <sir>,
#> # TOB <sir>, AMK <sir>, KAN <sir>, TMP <sir>, SXT <sir>, NIT <sir>,
#> # FOS <sir>, LNZ <sir>, CIP <sir>, MFX <sir>, VAN <sir>, TEC <sir>,
#> # TCY <sir>, TGC <sir>, DOX <sir>, ERY <sir>, CLI <sir>, AZM <sir>,
#> # IPM <sir>, MEM <sir>, MTR <sir>, CHL <sir>, COL <sir>, MUP <sir>, RIF <sir>
# 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 = 100,
replace = TRUE
)) %>%
group_by(patient, condition) %>%
mutate(new_episode = is_new_episode(date, 365)) %>%
select(patient, date, condition, new_episode) %>%
arrange(patient, condition, date)
}
#> # A tibble: 100 × 4
#> # Groups: patient, condition [97]
#> patient date condition new_episode
#> <chr> <date> <chr> <lgl>
#> 1 005088 2007-08-22 B TRUE
#> 2 012595 2002-06-18 C TRUE
#> 3 023456 2009-11-02 C TRUE
#> 4 071099 2005-01-11 C TRUE
#> 5 077552 2002-05-14 B TRUE
#> 6 080086 2010-08-08 B TRUE
#> 7 0E2483 2007-08-10 A TRUE
#> 8 0E2483 2007-11-10 A FALSE
#> 9 0E2483 2007-04-06 C TRUE
#> 10 114570 2003-04-22 B TRUE
#> # … with 90 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)
) %>%
arrange(patient, ward, date)
}
#> # A tibble: 100 × 5
#> # Groups: ward, patient [95]
#> ward date patient new_index new_logical
#> <chr> <date> <chr> <int> <lgl>
#> 1 Clinical 2007-08-22 005088 1 TRUE
#> 2 ICU 2002-06-18 012595 1 TRUE
#> 3 Clinical 2009-11-02 023456 1 TRUE
#> 4 Clinical 2005-01-11 071099 1 TRUE
#> 5 Clinical 2002-05-14 077552 1 TRUE
#> 6 Clinical 2010-08-08 080086 1 TRUE
#> 7 Clinical 2007-04-06 0E2483 2 TRUE
#> 8 Clinical 2007-11-10 0E2483 1 TRUE
#> 9 ICU 2007-08-10 0E2483 1 TRUE
#> 10 ICU 2003-04-22 114570 1 TRUE
#> # … with 90 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 58 14 41 49
#> 2 ICU 31 11 25 27
#> 3 Outpatient 6 5 6 6
# grouping on patients and microorganisms leads to the same
# results as first_isolate() when using 'episode-based':
if (require("dplyr")) {
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)
}
#> [1] FALSE
# but is_new_episode() has a lot more flexibility than first_isolate(),
# since you can now group on anything that seems relevant:
if (require("dplyr")) {
df %>%
group_by(patient, mo, ward) %>%
mutate(flag_episode = is_new_episode(date, 365)) %>%
select(group_vars(.), flag_episode)
}
#> # A tibble: 100 × 4
#> # Groups: patient, mo, ward [97]
#> patient mo ward flag_episode
#> <chr> <mo> <chr> <lgl>
#> 1 762305 B_BCTRD_FRGL Clinical TRUE
#> 2 889500 B_STPHY_CONS Clinical TRUE
#> 3 777449 B_STPHY_CONS ICU TRUE
#> 4 59C7F2 B_STRPT_PNMN Clinical TRUE
#> 5 432724 B_STPHY_CONS ICU TRUE
#> 6 690605 B_STRPT_DYSG ICU TRUE
#> 7 E04500 B_STPHY_HMNS Clinical TRUE
#> 8 255339 B_ESCHR_COLI Clinical TRUE
#> 9 905108 B_STRPT_PNMN Clinical TRUE
#> 10 130252 B_ENTRC_FCLS ICU TRUE
#> # … with 90 more rows
# }