File: mutation.network.Rd

package info (click to toggle)
r-cran-tcr 2.3.2%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, trixie
  • size: 2,316 kB
  • sloc: cpp: 187; makefile: 5
file content (49 lines) | stat: -rw-r--r-- 1,793 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
42
43
44
45
46
47
48
49
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/graph.R
\name{mutation.network}
\alias{mutation.network}
\title{Make mutation network for the given repertoire.}
\usage{
mutation.network(
  .data,
  .method = c("hamm", "lev"),
  .max.errors = 1,
  .label.col = "CDR3.amino.acid.sequence",
  .seg.col = "V.gene",
  .prob.col = "Probability"
)
}
\arguments{
\item{.data}{Either character vector of sequences, data frame with \code{.label.col}
or shared repertoire (result from the \code{shared.repertoire} function) constructed based on \code{.label.col}.}

\item{.method}{Either "hamm" (for hamming distance) or "lev" (for edit distance). Passed to the \code{find.similar.sequences} function.}

\item{.max.errors}{Passed to the \code{find.similar.sequences} function.}

\item{.label.col}{Name of the column with CDR3 sequences (vertex labels).}

\item{.seg.col}{Name of the column with V gene segments.}

\item{.prob.col}{Name of the column with clonotype probability.}
}
\value{
Mutation network, i.e. igraph object with input sequences as vertices labels, ???
}
\description{
Mutation network (or a mutation graph) is a graph with vertices representing nucleotide or in-frame amino acid sequences (out-of-frame amino acid sequences
will automatically filtered out) and edges are connecting pairs of sequences with hamming distance or edit distance between them
no more than specified in the \code{.max.errors} function parameter.
}
\examples{
\dontrun{
data(twb)
twb.shared <- shared.repertoire(twb)
G <- mutation.network(twb.shared)
get.people.names(G, 300, T)  # "Subj.A|Subj.B"
get.people.names(G, 300, F)  # list(c("Subj.A", "Subj.B"))
}
}
\seealso{
\link{shared.repertoire}, \link{find.similar.sequences}, \link{set.people.vector}, \link{get.people.names}
}