Description Usage Arguments Details Value Note Author(s) References See Also Examples

View source: R/pcairPartition.R

`pcairPartition`

is used to partition a sample from a genetic study into an ancestry representative 'unrelated subset' and a 'related subset'. The 'unrelated subset' contains individuals who are all mutually unrelated to each other and representative of the ancestries of all individuals in the sample, and the 'related subset' contains individuals who are related to someone in the 'unrealted subset'.

1 2 3 | ```
pcairPartition(kinobj, divobj,
kin.thresh = 2^(-11/2), div.thresh = -2^(-11/2),
unrel.set = NULL, sample.include = NULL, verbose = TRUE)
``` |

`kinobj` |
A symmetric matrix of pairwise kinship coefficients for every pair of individuals in the sample: upper and lower triangles must both be filled; diagonals should be self-kinship or set to a non-missing constant value. This matrix is used for partitioning the sample into the 'unrelated' and 'related' subsets. See 'Details' for how this interacts with |

`divobj` |
A symmetric matrix of pairwise ancestry divergence measures for every pair of individuals in the sample: upper and lower triangles must both be filled; diagonals should be set to a non-missing constant value. This matrix is used for partitioning the sample into the 'unrelated' and 'related' subsets. See 'Details' for how this interacts with |

`kin.thresh` |
Threshold value on |

`div.thresh` |
Threshold value on |

`unrel.set` |
An optional vector of IDs for identifying individuals that are forced into the unrelated subset. See 'Details' for how this interacts with |

`sample.include` |
An optional vector of IDs for selecting samples to consider for either set. |

`verbose` |
Logical indicator of whether updates from the function should be printed to the console; the default is TRUE. |

We recommend using software that accounts for population structure to estimate pairwise kinship coefficients to be used in `kinobj`

. Any pair of individuals with a pairwise kinship greater than `kin.thresh`

will be declared 'related.' Kinship coefficient estimates from the KING-robust software are typically used as measures of ancestry divergence in `divobj`

. Any pair of individuals with a pairwise divergence measure less than `div.thresh`

will be declared ancestrally 'divergent'. Typically, `kin.thresh`

and `div.thresh`

are set to be the amount of error around 0 expected in the estimate for a pair of truly unrelated individuals. If `unrel.set = NULL`

, the PC-AiR algorithm is used to find an 'optimal' partition (see 'References' for a paper describing the algorithm). If `unrel.set`

and `kinobj`

are both specified, then all individuals with IDs in `unrel.set`

are forced in the 'unrelated subset' and the PC-AiR algorithm is used to partition the rest of the sample; this is especially useful for including reference samples of known ancestry in the 'unrelated subset'.

For large sample sizes, storing both `kinobj`

and `divobj`

in memory may be prohibitive. Both matrices may be stored in GDS files and provided as `gds.class`

objects. `pcrelate`

has an option to save results in GDS format, and we provide utility functions to save KING output in this format as well.

Matrix objects from the Matrix package are also supported.

A list including:

`rels` |
A vector of IDs for individuals in the 'related subset'. |

`unrels` |
A vector of IDs for individuals in the 'unrelated subset'. |

`pcairPartition`

is called internally in the function `pcair`

but may also be used on its own to partition the sample into an ancestry representative 'unrelated' subset and a 'related' subset without performing PCA.

Matthew P. Conomos

Conomos M.P., Miller M., & Thornton T. (2015). Robust Inference of Population Structure for Ancestry Prediction and Correction of Stratification in the Presence of Relatedness. Genetic Epidemiology, 39(4), 276-293.

Manichaikul, A., Mychaleckyj, J.C., Rich, S.S., Daly, K., Sale, M., & Chen, W.M. (2010). Robust relationship inference in genome-wide association studies. Bioinformatics, 26(22), 2867-2873.

`pcair`

which uses this function for finding principal components in the presence of related individuals.
`kingToMatrix`

for creating a matrix of kinship coefficent estimates or pairwise ancestry divergence measures from KING output text files that can be used as `kinobj`

or `divobj`

.
`kin2gds`

and `mat2gds`

for saving kinship matrices to GDS.

1 2 3 4 5 | ```
# load saved matrix of KING-robust estimates
data("HapMap_ASW_MXL_KINGmat")
# partition the sample
part <- pcairPartition(kinobj = HapMap_ASW_MXL_KINGmat,
divobj = HapMap_ASW_MXL_KINGmat)
``` |

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.