getOutbreakAttribute: Get attributes related to an outbreak

Description Usage Arguments Value See Also

View source: R/getOutbreakAttribute.R

Description

getOutbreakAttribute() specifies the object used to get related information about an outbreak. This function wraps getAttribute() to allow iteration over multiple outbreaks.

Usage

1
getOutbreakAttribute(attribute, outbreak)

Arguments

attribute

Character scalar. Names the CCM object to obtain related information about a case. One of the currently supported objects:

  1. exposures

  2. investigations

  3. locations

outbreak

Character scalar or vector. Names the Outbreak Id to use when obtaining information.

Value

A tibble of information related to an Outbreak.

See Also

getAttribute() for information on how the CCM query is executed. getOutbreaks() for obtaining Outbreak Ids required for this function.


DurhamRegionHARP/ccmReportR documentation built on Feb. 19, 2021, 2:54 p.m.