dvir (version 3.3.0)

relabelDVI: Automatic labelling of a DVI dataset

Description

Relabel the individuals and families in a DVI dataset.

Usage

relabelDVI(
  dvi,
  victims = NULL,
  victimPrefix = NULL,
  familyPrefix = NULL,
  refs = NULL,
  refPrefix = NULL,
  missingPrefix = NULL,
  missingFormat = NULL,
  othersPrefix = NULL
)

Value

A dviData() object.

Arguments

dvi

A dviData object, typically created with dviData().

victims

A named vector of the form c(old = new) with names for the PM samples, or a function to be applied to the existing names.

victimPrefix

Prefix used to label PM individuals.

familyPrefix

Prefix used to label the AM families.

refs

A named vector of the form c(old = new) with names for the typed references, or a function to be applied to the existing names.

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 missingPrefix and missingFormat can be given.

missingFormat

A string indicating family-wise labelling of missing persons, using [FAM], [IDX], [MIS] as place holders with the following meanings (see Examples):

• [FAM]: family index

• [IDX]: index of missing person within the family

• [MIS]: index within all missing persons

othersPrefix

Prefix used to label other untyped individuals. Use "" for numeric labels ( 1, 2, ...).

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]")