getSimpleFams {dvir}R Documentation

Find the simple families of a DVI dataset

Description

Extract the names (if present) or indices of the simple reference families, i.e., the families containing exactly 1 missing person.

Usage

getSimpleFams(dvi)

Arguments

dvi

A dviData object.

Value

A character (if dvi$am has names) or integer vector.

See Also

getFamily()

Examples

# No simple families
simple1 = getSimpleFams(example1)
stopifnot(length(simple1) == 0)

# Second family is simple
simple2 = getSimpleFams(example2)
stopifnot(simple2 == 2)

# With family names
simple3 = example2 |> relabelDVI(familyPrefix = "FAM") |> getSimpleFams()
stopifnot(simple3 == "FAM2")


[Package dvir version 3.2.1 Index]