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] 36 31 10 45 37 31 22 44 49 1 15 11 16 26 19 18 9 45 47 35 6 2 3 44 8
#> [26] 13 2 40 10 1 19 14 32 3 46 22 48 44 47 7 34 34 48 39 27 12 29 17 1 6
#> [51] 12 33 35 49 37 39 44 3 30 49 38 37 39 43 6 29 6 5 7 20 22 46 14 6 48
#> [76] 6 43 34 45 1 20 10 50 4 15 4 31 20 42 25 24 41 5 7 34 28 47 23 15 21
is_new_episode(df$date, episode_days = 60) # TRUE/FALSE
#> [1] TRUE TRUE TRUE TRUE TRUE FALSE TRUE TRUE TRUE TRUE TRUE TRUE
#> [13] TRUE TRUE TRUE TRUE TRUE FALSE TRUE TRUE TRUE TRUE TRUE FALSE
#> [25] TRUE TRUE FALSE TRUE FALSE FALSE FALSE TRUE TRUE FALSE TRUE FALSE
#> [37] TRUE FALSE FALSE TRUE TRUE FALSE FALSE TRUE TRUE TRUE TRUE TRUE
#> [49] FALSE FALSE FALSE TRUE FALSE FALSE FALSE FALSE FALSE FALSE TRUE FALSE
#> [61] TRUE FALSE FALSE TRUE FALSE FALSE FALSE TRUE FALSE TRUE FALSE FALSE
#> [73] FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE FALSE TRUE TRUE
#> [85] FALSE FALSE FALSE FALSE TRUE TRUE TRUE TRUE FALSE FALSE FALSE TRUE
#> [97] 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: 3 × 46
#> date patient age gender ward mo PEN OXA FLC AMX
#> <date> <chr> <dbl> <chr> <chr> <mo> <sir> <sir> <sir> <sir>
#> 1 2002-11-11 D80753 74 F Outpatie… B_STPHY_CONS R NA S NA
#> 2 2002-11-18 956065 89 F Clinical B_ESCHR_COLI R NA NA NA
#> 3 2002-11-16 762305 87 F Clinical B_PROTS_MRBL R NA NA NA
#> # … with 36 more variables: AMC <sir>, 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 022060 2004-05-04 A TRUE
#> 2 022060 2004-05-04 C TRUE
#> 3 067927 2002-01-29 C TRUE
#> 4 071099 2005-01-11 C TRUE
#> 5 0F9638 2014-09-22 B TRUE
#> 6 174209 2011-10-03 A TRUE
#> 7 183220 2008-11-14 A TRUE
#> 8 189363 2004-03-16 A TRUE
#> 9 218912 2007-02-24 A TRUE
#> 10 218912 2002-07-30 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 [94]
#> ward date patient new_index new_logical
#> <chr> <date> <chr> <int> <lgl>
#> 1 ICU 2004-05-04 022060 1 TRUE
#> 2 ICU 2004-05-04 022060 1 FALSE
#> 3 ICU 2002-01-29 067927 1 TRUE
#> 4 Clinical 2005-01-11 071099 1 TRUE
#> 5 Clinical 2014-09-22 0F9638 1 TRUE
#> 6 Outpatient 2011-10-03 174209 1 TRUE
#> 7 Clinical 2008-11-14 183220 1 TRUE
#> 8 Clinical 2004-03-16 189363 1 TRUE
#> 9 ICU 2002-07-30 218912 1 TRUE
#> 10 ICU 2007-02-24 218912 2 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 60 12 37 43
#> 2 ICU 28 11 23 26
#> 3 Outpatient 6 4 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] TRUE
# 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 [98]
#> patient mo ward flag_episode
#> <chr> <mo> <chr> <lgl>
#> 1 FC0C51 B_ESCHR_COLI Clinical TRUE
#> 2 D58366 B_ENTRC_FCLS Clinical TRUE
#> 3 E15167 B_ENTRC_FCLS Clinical TRUE
#> 4 964129 B_SERRT_MRCS Clinical TRUE
#> 5 0F9638 B_ESCHR_COLI Clinical TRUE
#> 6 A66134 B_STPHY_AURS Clinical TRUE
#> 7 183220 B_STPHY_CONS Clinical TRUE
#> 8 960787 B_ENTRC_FACM Clinical TRUE
#> 9 BF4515 B_ENTRC_FACM ICU TRUE
#> 10 495616 B_STPHY_EPDR Clinical TRUE
#> # … with 90 more rows
# }