ParentOffspring-class: Object containing the sample identifiers for members in a...

Description Usage Arguments Slots See Also Examples

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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

1

MinimumDistance documentation built on Nov. 8, 2020, 11:11 p.m.