read.snps.pedfile {chopsticks} | R Documentation

## Read genotype data from a LINKAGE "pedfile"

### Description

This function reads data arranged as a LINKAGE "pedfile" with some restrictions and returns a list of three objects: a data frame containing the initial 6 fields giving pedigree structure, sex and disease status, a vector or a data frame containing snp assignment and possibly other snp infomation, and an object of class `"snp.matrix"` or `"X.snp.matrix"` containing the genotype data

### Usage

    read.snps.pedfile(file, snp.names=NULL, assign=NULL, missing=NULL, X=FALSE, sep=".", low.mem = FALSE)

### Arguments

`file` | The file name for the input pedfile
`snp.names` | A character vector giving the SNP names. If an accompanying map file or an info file is present, it will be read and the information used for the SNP names, and also the information merged with the result. If absent, the SNPs will be named numerically ("1", "2", ...)
`assign` | A list of named mappings for which letter maps to which Allele; planned for the future, not currently used
`missing` | Meant to be a single character giving the code recorded for alleles of missing genotypes ; not used in the current code
`X` | If `TRUE` the pedfile is assumed to describe loci on the X chromosome
`sep` | The character separating the family and member identifiers in the constructed row names; not used
`low.mem` | Switch over to input with a routine which requires less memory to run, but takes a little longer. This option also has the disadvantage that assignment of A/B genotype is somewhat non-deterministic and depends the listed order of samples.

### Details

Input variables are assumed to take the usual codes, with the restriction that the family (or pedigree) identifiers will be held as strings, but identifiers for members within families must be coded as integers. Genotype should be coded as pairs of single character allele codes (which can be alphameric or numeric), from either 'A', 'C', 'G', 'T' or '1', '2', '3', '4', with 'N', '-' and '0' denoting a missing; everything else is considered invalid and would invalidate the whole snp; also more than 2 alleles also cause the snp to be marked invalid.

Row names of the output objects are constructed by concatenation of the pedigree and member identifiers, "Family", "Individual" joined by ".", e.g. "Family.Adams.Individual.0".

### Value

`snps` | The output `"snp.matrix"` or `"X.snp.matrix"`
`subject.support` | A data frame containing the first six fields of the pedfile

### Author(s)

Hin-Tak Leung

### See Also

`snp.matrix-class`, `X.snp.matrix-class`, `read.snps.long`, `read.HapMap.data`, `read.pedfile.info`, `read.pedfile.map`

[Package chopsticks version 1.56.0 Index]