X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=man%2Fbase.freq.Rd;h=8832fccf71001779e0290f7ae786d52d0caa6060;hb=2014b83971be4b9cd1644d6127837df798e9335c;hp=56a5e2e7f39774a22eff64aea8cba6e84de2b399;hpb=f3304b6f40610d9b7306a9275d593b5c038ab0a0;p=ape.git diff --git a/man/base.freq.Rd b/man/base.freq.Rd index 56a5e2e..8832fcc 100644 --- a/man/base.freq.Rd +++ b/man/base.freq.Rd @@ -1,5 +1,6 @@ \name{base.freq} \alias{base.freq} +\alias{GC.content} \alias{Ftab} \title{Base frequencies from DNA Sequences} \description{ @@ -7,11 +8,15 @@ the four DNA bases (adenine, cytosine, guanine, and thymidine) from a sample of sequences. + \code{GC.content} computes the proportion of G+C (using the previous + function). All missing or unknown sites are ignored. + \code{Ftab} computes the contingency table with the absolute frequencies of the DNA bases from a pair of sequences. } \usage{ base.freq(x, freq = FALSE, all = FALSE) +GC.content(x) Ftab(x, y = NULL) } \arguments{ @@ -26,8 +31,7 @@ Ftab(x, y = NULL) } \details{ The base frequencies are computed over all sequences in the - sample. All missing or unknown sites are discarded from the - computations. + sample. For \code{Ftab}, if the argument \code{y} is given then both \code{x} and \code{y} are coerced as vectors and must be of equal length. If @@ -35,18 +39,21 @@ Ftab(x, y = NULL) the two first sequences are used. } \value{ - A numeric vector with names \code{c("a", "c", "g", "t")}, or a four by - four matrix with similar dimnames. + A numeric vector with names \code{c("a", "c", "g", "t")} (and possibly + \code{"r", "m", ...}, a single numeric value, or a four by four matrix + with similar dimnames. } \author{Emmanuel Paradis} \seealso{ - \code{\link{GC.content}}, \code{\link{seg.sites}}, - \code{\link{nuc.div}}, \code{\link{DNAbin}} + \code{\link{seg.sites}}, \code{\link[pegas]{nuc.div}}, + \code{\link{DNAbin}} } \examples{ data(woodmouse) base.freq(woodmouse) base.freq(woodmouse, TRUE) +base.freq(woodmouse, TRUE, TRUE) +GC.content(woodmouse) Ftab(woodmouse) Ftab(woodmouse[1, ], woodmouse[2, ]) # same than above Ftab(woodmouse[14:15, ]) # between the last two