subset_clusters_by_id: Subset epicontacts by case-specified clusters

View source: R/subset_clusters_by_id.R

subset_clusters_by_idR Documentation

Subset epicontacts by case-specified clusters

Description

This function subsets an epicontacts object by identifying clusters of cases connected to specified cases.

Usage

subset_clusters_by_id(x, id)

Arguments

x

an epicontacts object

id

a character vector of case identifiers; the connected components attached to these cases will be retained in the output object.

Value

An epicontacts object whose contact dataframe corresponds to all clusters containing specified case id.

Author(s)

Nistara Randhawa (nrandhawa@ucdavis.edu)

Examples

if (require(outbreaks)) {
## build data
x <- make_epicontacts(ebola_sim$linelist, ebola_sim$contacts,
                       id="case_id", to="case_id", from="infector",
                       directed=TRUE)


id <- "cac51e" ## it can be a vector of id as well


## subset based on cluster to which "cac51e" belongs
x_subset <- subset_clusters_by_id(x, id)

}

Hackout3/contacts documentation built on March 2, 2024, 5:41 a.m.