R: Conversion of a 'pedigree' object into a list of trio objects
ped2trio
R Documentation
Conversion of a pedigree object into a list of trio objects
Description
Creates trio objects representing the pedigree structure contained in the pedigree object.
Usage
ped2trio(ped)
Arguments
ped
a pedigree object
Details
The function processes the pedigree from the bottom generation to the top, adding new trio objects for each non-founder in a generation, with in their offspring list the trio objects associated to their children. At the top generation, there are as many trio objects as the number of founder couples, and these are returned as a list of trio objects. For now, only founders are allowed to have more than one spouse, non-founders can only have one spouse.
Value
object
list of Trio objects, one list for each founder couple of the pedigree
R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)
R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.
R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.
Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.
> library(RVsharing)
Welcome to RVsharing version 1.6.0
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/RVsharing/ped2trio.Rd_%03d_medium.png", width=480, height=480)
> ### Name: ped2trio
> ### Title: Conversion of a 'pedigree' object into a list of trio objects
> ### Aliases: ped2trio
>
> ### ** Examples
>
> data(ped.list)
> ped.trio1 = ped2trio(ped.list[[1]])
>
>
>
>
>
> dev.off()
null device
1
>