famid {pedtools}

Family identifier

Description

Functions for getting or setting the family ID of a ped object.

Usage

famid(x, ...)

## S3 method for class 'ped'
famid(x, ...)

famid(x, ...) <- value

## S3 replacement method for class 'ped'
famid(x, ...) <- value

Arguments

x

A ped object

...

(Not used)

value

The new family ID, which must be (coercible to) a character string.

Examples

x = nuclearPed(1)
famid(x) # empty string

famid(x) = "trio"
famid(x)