File: get.kmers.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 (41 lines) | stat: -rw-r--r-- 1,194 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/kmers.R
\name{get.kmers}
\alias{get.kmers}
\title{Get kmers from sequences.}
\usage{
get.kmers(
  .data,
  .head = -1,
  .k = 5,
  .clean = T,
  .meat = F,
  .verbose = T,
  .left.shift = 0,
  .right.shift = 0
)
}
\arguments{
\item{.data}{Either character vector or a data.frame.}

\item{.head}{Parameter for head function applied to the given data before kmer generation.}

\item{.k}{Size of the kmer.}

\item{.clean}{if T then remove sequences which contain '~' or '*' symbols. Useful for deleting out-of-frame aminoacid sequnces.}

\item{.meat}{if TRUE than .data must be data.frame with columns CDR3.amino.acid.sequence and Read.count.}

\item{.verbose}{if T then print progress.}

\item{.left.shift}{Cut all \code{.left.shift} symbols from the left side for each sequence.}

\item{.right.shift}{Cut all \code{.right.shift} symbols from the right side for each sequence.}
}
\value{
Data.frame with 2 columns Kmers and Count / Rank / Proportion relatively to the .value param
or a list with such data.frames if .data is a list.
}
\description{
Get vector of kmers from the given character vector or data frame.
}