File: probabilityToSnpMatrix.Rd

package info (click to toggle)
r-bioc-variantannotation 1.10.5-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 2,172 kB
  • ctags: 109
  • sloc: ansic: 1,088; sh: 4; makefile: 2
file content (56 lines) | stat: -rw-r--r-- 1,372 bytes parent folder | download | duplicates (6)
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
\name{probabilityToSnpMatrix}

\alias{probabilityToSnpMatrix}

\title{Convert posterior genotype probability to a SnpMatrix object}

\description{
  Convert a matrix of posterior genotype probabilites P(AA), P(AB),
  P(BB) to a \link[snpStats:SnpMatrix-class]{SnpMatrix}.
}

\usage{
  probabilityToSnpMatrix(probs)
}

\arguments{
  \item{probs}{Matrix with three columns for the posterior probabilities
  of the three genotypes: "P(A/A)", "P(A/B)", "P(B/B)".  Each row must
  sum to 1.}
}

\details{
  \code{probabilityToSnpMatrix} converts a matrix of posterior
  probabilites of genotype calls into a 
  \link[snpStats:SnpMatrix-class]{SnpMatrix}.
}

\value{
  An object of class \code{"SnpMatrix"} with one row (one sample).
  Posterior probabilities are encoded (approximately) as byte
  values, one per SNP. See 
    the help page for \link[snpStats:SnpMatrix-class]{SnpMatrix} for complete 
    details of the class structure.
}

\author{
  Stephanie Gogarten <sdmorris@u.washington.edu>
}

\seealso{
  \link{genotypeToSnpMatrix},
  \link[snpStats:SnpMatrix-class]{SnpMatrix}
}

\examples{
probs <- matrix(c(1,0,0,
                  0,1,0,
                  0,0,1,
                  NA,NA,NA),
                  ncol=3, byrow=TRUE,
                  dimnames=list(1:4,c("A/A","A/B","B/B")))
sm <- probabilityToSnpMatrix(probs)
as(sm, "character")
}

\keyword{manip}