File: summary.map.Rd

package info (click to toggle)
qtl 1.08-56-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 3,552 kB
  • ctags: 242
  • sloc: ansic: 8,903; makefile: 1
file content (41 lines) | stat: -rw-r--r-- 1,116 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
\name{summary.map}
\alias{summary.map}

\title{Print summary of a genetic map}

\description{
  Print summary information about a \code{map} object.
}

\usage{
\method{summary}{map}(object, \dots)
}

\arguments{
 \item{object}{An object of class \code{map}, which is a list of
   vectors (or, for a sex-specific map, 2-row matrices), each specifying
   the locations of the markers.  The object can also be of class
   \code{cross}, in which case the function \code{\link[qtl]{pull.map}}
   is used to extract the genetic map from the object.}
 \item{\dots}{Ignored at this point.}
}

\value{
  An object of class \code{summary.map}, which is just a data.frame 
  containing the number of markers, length, the average inter-marker
  spacing, and the maximum distance between markers, for each chromosome
  and overall.  An attribute \code{sexsp} indicates whether the map was
  sex-specific.
}

\author{Karl W Broman, \email{kbroman@biostat.wisc.edu} }

\examples{
data(map10)
summary(map10)
}

\seealso{ \code{\link[qtl]{chrlen}}, \code{\link[qtl]{pull.map}},
  \code{\link[qtl]{summary.cross}} } 

\keyword{print}