File: build.charmatrix.Rd

package info (click to toggle)
r-cran-prabclus 2.3-2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 1,392 kB
  • sloc: sh: 13; makefile: 2
file content (48 lines) | stat: -rw-r--r-- 1,547 bytes parent folder | download | duplicates (2)
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
\name{build.charmatrix}
\alias{build.charmatrix}
%- Also NEED an `\alias' for EACH other topic documented here.
\title{Internal: create character matrix out of allele list}
\description{
  For use in \code{\link{alleleinit}}.
  Creates a matrix of characters in which there are two rows for
    every individual corresponding to the two alleles in every locus
    (column) out of a list of lists, such as required by
    \code{\link{alleledist}}.
}

\usage{
   build.charmatrix(allelelist,n.individuals,n.variables)
}
%- maybe also `usage' for other objects documented here.
\arguments{
  \item{allelelist}{A list of lists. In the "outer" list, there are
  \code{n.variables} lists, one for each locus. In the "inner" list, for every
    individual there is a vector of two codes (typically characters, see
    \code{\link{alleleinit}}) for the two alleles in that locus.}  
  \item{n.individuals}{integer. Number of individuals.}
  \item{n.variables}{integer. Number of loci.}
}
  
\value{
  A matrix of characters in which there are two rows for
    every individual corresponding to the two alleles in every locus
    (column). 
}

\author{Christian Hennig
  \email{christian.hennig@unibo.it}
  \url{https://www.unibo.it/sitoweb/christian.hennig/en}}

\seealso{\code{\link{alleleinit}}, \code{\link{unbuild.charmatrix}}}

\examples{
  alist <- list()
  alist[[1]] <- list(c("A","A"),c("B","A"),c(NA,NA))
  alist[[2]] <- list(c("A","C"),c("B","B"),c("A","D"))
  build.charmatrix(alist,3,2)
}
\keyword{manip}% at least one, from doc/KEYWORDS