epid object

S4 objects storing the result of episodes.

is.epid(x)

as.epid(x, ...)

# S3 method for epid
format(x, ...)

# S3 method for epid
unique(x, ...)

# S3 method for epid
summary(object, ...)

# S3 method for epid_summary
print(x, ...)

# S3 method for epid
as.data.frame(x, ..., decode = TRUE)

# S3 method for epid
as.list(x, ..., decode = TRUE)

# S4 method for epid
show(object)

# S4 method for epid
rep(x, ...)

# S4 method for epid
[(x, i, j, ..., drop = TRUE)

# S4 method for epid
[[(x, i, j, ..., exact = TRUE)

# S4 method for epid
c(x, ...)

Arguments

x

x

...

...

object

object

decode

If TRUE, data is decoded

i

i

j

j

drop

drop

exact

exact

Slots

sn

Unique record identifier.

.Data

Unique episode identifier.

wind_id

Unique reference ID for each match.

wind_nm

Type of window i.e. "Case" or "Recurrence".

case_nm

Record type in regards to case assignment.

dist_wind_index

Unit difference between each record and its window's reference record.

dist_epid_index

Unit difference between each record and its episode's reference record.

epid_dataset

Data sources in each episode.

epid_interval

The start and end dates of each episode. A number_line object.

epid_length

The duration or length of (epid_interval).

epid_total

The number of records in each episode.

iteration

The iteration when a record was matched to it's group (.Data).

options

Some options passed to the instance of episodes.

Examples

# A test for `epid` objects
ep <- episodes(date = 1)
is.epid(ep); is.epid(2)
#> [1] TRUE
#> [1] FALSE

ep <- episodes(date = 1)
is.epid(ep); is.epid(2)
#> [1] TRUE
#> [1] FALSE