Column Names In A Relatedness Table

Which columns of the relatedness data frame hold the pair identifiers and the relatedness measure. Built by this constructor rather than passed as a bare list so a misspelled field fails at the call site instead of silently leaving the default in place.

Usage

RelatednessColumnsParam(
  iid1 = "IID1",
  iid2 = "IID2",
  fid1 = NULL,
  fid2 = NULL,
  value = "PI_HAT"
)

Arguments

iid1, iid2

Column names for the first and second individual ID. Defaults "IID1" and "IID2".

fid1, fid2

Column names for the first and second family ID, or NULL (default) when the table has none.

value

Column name for the relatedness measure. Default "PI_HAT".

Value

A RelatednessColumnsParam object, a MethodParam.

Examples

RelatednessColumnsParam(value = "KINSHIP")
#> <RelatednessColumnsParam>
#>   iid1                     IID1
#>   iid2                     IID2
#>   value                    KINSHIP
#>   unset: fid1, fid2