File: seqEqual.Rd

package info (click to toggle)
r-cran-alakazam 0.2.11-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 2,128 kB
  • sloc: cpp: 167; makefile: 5
file content (40 lines) | stat: -rw-r--r-- 1,167 bytes parent folder | download | duplicates (4)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RcppExports.R
\name{seqEqual}
\alias{seqEqual}
\title{Test DNA sequences for equality.}
\usage{
seqEqual(seq1, seq2, ignore = as.character(c("N", "-", ".", "?")))
}
\arguments{
\item{seq1}{character string containing a DNA sequence.}

\item{seq2}{character string containing a DNA sequence.}

\item{ignore}{vector of characters to ignore when testing for equality.
Default is to ignore c("N",".","-","?")}
}
\value{
Returns \code{TRUE} if sequences are equal and \code{FALSE} if they are not.
          Sequences of unequal length will always return \code{FALSE} regardless of
          their character values.
}
\description{
\code{seqEqual} checks if two DNA sequences are identical.
}
\examples{
# Ignore gaps
seqEqual("ATG-C", "AT--C")
seqEqual("ATGGC", "ATGGN")
seqEqual("AT--T", "ATGGC")

# Ignore only Ns
seqEqual("ATG-C", "AT--C", ignore="N")
seqEqual("ATGGC", "ATGGN", ignore="N")
seqEqual("AT--T", "ATGGC", ignore="N")

}
\seealso{
Used by \link{pairwiseEqual} within \link{collapseDuplicates}.
          See \link{seqDist} for calculation Hamming distances between sequences.
}