admixr: eigenstrat – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

eigenstrat

EIGENSTRAT data constructor

Description

This function creates an instance of the EIGENSTRAT S3 class, which encapsulates all paths to data files required for an ADMIXTOOLS analysis.

Usage

eigenstrat(prefix = NULL, ind = NULL, snp = NULL, geno = NULL, exclude = NULL)

Arguments

`prefix`	Shared path to an EIGENSTRAT trio (set of ind/snp/geno files).
`ind, snp, geno`	Paths to individual EIGENSTRAT components.
`exclude`	Pre-defined snp file with excluded sites.

Value

S3 object of the EIGENSTRAT class.

Examples

## Not run: # download an example genomic data and get the path prefix to the
# trio of snp/geno/ind files in an EIGENSTRAT format
prefix <- download_data(dirname = tempdir())

# wrap the trio of snp/geno/ind files in an object of the class
# EIGENSTRAT
snps <- eigenstrat(prefix)

## End(Not run)

admixr

An Interface for Running 'ADMIXTOOLS' Analyses

v0.9.1

MIT + file LICENSE

Authors

Martin Petr [aut, cre] (<https://orcid.org/0000-0003-4879-8421>)

Initial release