ParentOffspring-class {MinimumDistance} | R Documentation

## Object containing the sample identifiers for members in a pedigree

### Description

Container for registering sample identifiers with membership in a pedigree. For representing multiple pedigrees, see `ParentOffspringList`.

Accessor for the sample identifiers for the members in a pedigree

### Usage

    offspring(object)

    mother(object)

    father(object)

    ParentOffspring(
      id = character(),
      father = character(),
      mother = character(),
      offspring = character(),
      parsedPath = character()
    )

    ## S4 method for signature 'ParentOffspring'
    pedigreeName(object)

    ## S4 method for signature 'ParentOffspring'
    father(object)

    ## S4 method for signature 'ParentOffspring'
    mother(object)

    ## S4 method for signature 'ParentOffspring'
    offspring(object)

    ## S4 method for signature 'ParentOffspring'
    show(object)

    ## S4 method for signature 'ParentOffspring'
    names(x)

### Arguments

`object` | a `ParentOffspring` object
`id` | length-one character vector providing a family-level id
`father` | length-one character vector providing sample ids for father
`mother` | length-one character vector providing sample ids for mother
`offspring` | character vector providing sample ids for offspring (can have length greater than one if there is more than one offspring)
`parsedPath` | character vector providing path to low-level data
`x` | a `ParentOffspring` object

### Slots

`id`

  length-one character vector providing a family-level id

`father`

  length-one character vector providing sample ids for father

`mother`

  length-one character vector providing sample ids for mother

`offspring`

  character vector providing sample ids for offspring (can have length greater than one if there is more than one offspring)

`parsedPath`

  character vector providing path to parsed files of the marker-level summaries

### See Also

ParentOffspringList-class

### Examples

    ParentOffspring()

[Package MinimumDistance version 1.36.0 Index]