dot-restoreNames: Restore user-specified column names in a connections data...

.restoreNamesR Documentation

Restore user-specified column names in a connections data frame

Description

Rename standard internal columns in a pedigree connections data frame back to user-specified names.

Usage

.restoreNames(
  connections,
  personID = "personID",
  momID = "momID",
  dadID = "dadID",
  spouseID = "spouseID",
  twinID = "twinID",
  famID = "famID"
)

restoreNames(
  connections,
  personID = "personID",
  momID = "momID",
  dadID = "dadID",
  spouseID = "spouseID",
  twinID = "twinID",
  famID = "famID"
)

Arguments

connections

A data frame containing connection identifiers whose columns may currently be named with internal defaults such as 'personID', 'momID', 'dadID', 'spouseID', 'twinID', 'famID'.

personID

Character string specifying the column name for individual IDs. Defaults to "personID".

momID

Character string specifying the column name for mother IDs. Defaults to "momID".

dadID

Character string specifying the column name for father IDs. Defaults to "dadID".

spouseID

Character string specifying the column name for spouse IDs. Defaults to "spouseID".

twinID

Character string specifying the column name for twin IDs. Defaults to "twinID".

famID

Character string specifying the column name for family IDs. Defaults to "famID".


ggpedigree documentation built on Sept. 13, 2025, 1:08 a.m.