\name{getFounders} \alias{getFounders} %- Also NEED an '\alias' for EACH other topic documented here. \title{ Get founders' information} \description{ Get a subset of pedigree object containing only founders' information. } \usage{ getFounders(pedObj) } %- maybe also 'usage' for other objects documented here. \arguments{ \item{pedObj}{a list with five elements: \code{ped}, \code{columns}, \code{markerNames}, \code{Position}, and \code{filename}. \code{ped} is a pedigree data frame whose first 6 columns are family (pedigree id), pid (patient id), father (father id), mother (mother id), sex, affected (affection status). The remaining columns are pairs of marker alleles. Each row corresponds to an individual; \code{columns} are the names of the first 5 (or 6) columns of ped file. It should be either equal to c("family","pid","father","mother","sex","affected") or equal to c("family","pid","father","mother","sex"); \code{founderOnly} indicates if using only founder info; \code{markerNames} is a vector of marker names; \code{Position} is a vector of marker positions; \code{fileName} is the pedigree file name} } \details{ } \value{ An pedigree object contains only founders' information. } \references{ ~put references to the literature/web site here ~ } \author{ Weiliang Qiu \email{stwxq@channing.harvard.edu}, Ross Lazarus \email{ross.lazarus@channing.harvard.edu}, Gregory Warnes \email{warnes@bst.rochester.edu}, Nitin Jain \email{nitin.jain@pfizer.com} } \note{ } \seealso{ } \examples{ } \keyword{ misc }% at least one, from doc/KEYWORDS