OutbreakTools (version 0.1-16)

get.individuals: Retrieve individual identifiers

Description

get.individuals is a generic function with a method for '>obkData, '>obkSequences and '>obkContacts objects. It can be used to retrieve individuals identifiers stored in the object.

Usage

get.individuals(x, …)
get.nindividuals(x, …)
# S4 method for obkData
get.individuals(x,
    data=c("all", "individuals", "records", "contacts", "dna"), …)
# S4 method for obkData
get.nindividuals(x,
    data=c("all", "individuals", "records", "contacts", "dna"), …)
# S4 method for obkSequences
get.individuals(x, …)
# S4 method for obkSequences
get.nindividuals(x, …)
# S4 method for obkContacts
get.individuals(x, …)
# S4 method for obkContacts
get.nindividuals(x, …)

Arguments

x

an input object to seek individuals from.

data

a character string indicating the name of the data field to look for. It can be 'all'(default), 'individuals', 'records' or 'context'.

…

currently not used.

Examples

# NOT RUN {
## LOAD DATA ##
data(ToyOutbreak)

## VARIOUS USE OF GET.INDIVIDUALS ##
get.individuals(ToyOutbreak)

get.nindividuals(ToyOutbreak, "records")
get.individuals(ToyOutbreak, "records")

get.nindividuals(ToyOutbreak, "contacts")
get.individuals(ToyOutbreak, "contacts")


# }