MangrovePed {Mangrove}R Documentation

The MangrovePed class

Description

Functions to read in and summarise MangrovePed objects

Usage


readPed(prefix)

## S3 method for class 'MangrovePed'
summary(object, ...)
## S3 method for class 'MangrovePed'
print(x, ...)
## S3 method for class 'MangrovePed'
plot(x, ...)

Arguments

prefix

The prefix for the file locations of a pair pedigree and map files, such as produced by the program Plink. Requires prefix.ped and prefix.map to both exist.

x

An object of class MangrovePed

object

An object of class MangrovePed

...

Arguments to be passed on to other methods.

Details

A MangrovePed object holds genotypes and family relationships for a number of individuals. You can read in such data from a Plink pedigree file using readPed.

You can show the raw pedigree data using the print method and get summary information (such as number of samples, cases and variants) using the summary method. The plot function produces an error.

Value

For readPed, an object of class MangrovePed. For methods, nothing is returned.

See Also

MangroveORs, MangroveTree.

Examples

data(famped)
summary(famped)
print(famped)

[Package Mangrove version 1.21 Index]