relabelDVI {dvir} | R Documentation |
Automatic labelling of a DVI dataset
Description
Relabel the individuals and families in a DVI dataset.
Usage
relabelDVI(
dvi,
victimPrefix = NULL,
familyPrefix = NULL,
refPrefix = NULL,
missingPrefix = NULL,
missingFormat = NULL,
othersPrefix = NULL
)
Arguments
dvi |
A |
victimPrefix |
Prefix used to label PM individuals. |
familyPrefix |
Prefix used to label the AM families. |
refPrefix |
Prefix used to label the reference individuals, i.e., the typed members of the AM families. |
missingPrefix |
Prefix used to label the missing persons. At most one of
|
missingFormat |
A string indicating family-wise labelling of missing
persons, using
|
othersPrefix |
Prefix used to label other untyped individuals. Use "" for numeric labels ( 1, 2, ...). |
Value
A dviData()
object.
Examples
# Builtin dataset `example2`
relabelDVI(example2,
victimPrefix = "vic",
familyPrefix = "fam",
refPrefix = "ref",
missingPrefix = "mp")
# Family-wise labelling of missing persons
relabelDVI(example2, missingFormat = "M[FAM]-[IDX]")
relabelDVI(example2, missingFormat = "M[IDX] (F[FAM])")
relabelDVI(example2, missingFormat = "fam[FAM].m[IDX]")
[Package dvir version 3.2.1 Index]