File: get.inframes.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,333 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stats.R
\name{get.inframes}
\alias{get.inframes}
\alias{get.outframes}
\alias{count.inframes}
\alias{count.outframes}
\alias{get.frames}
\alias{count.frames}
\alias{clonotypescount}
\title{In-frame / out-of-frame sequences filter.}
\usage{
get.inframes(.data, .head = 0, .coding = T)

get.outframes(.data, .head = 0)

count.inframes(.data, .head = 0, .coding = T)

count.outframes(.data, .head = 0)

get.frames(.data, .frame = c('in', 'out', 'all'), .head = 0, .coding = T)

count.frames(.data, .frame = c('in', 'out', 'all'), .head = 0, .coding = T)
}
\arguments{
\item{.data}{MiTCR data.frame or a list with mitcr data.frames.}

\item{.head}{Parameter to the head() function. Supply 0 to get all elements. \code{head} applied before subsetting, i.e.
if .head == 500, you will get in-frames from the top 500 clonotypes.}

\item{.coding}{if T then return only coding sequences, i.e. without stop-codon.}

\item{.frame}{Which *-frames to choose.}
}
\value{
Filtered data.frame or a list with such data.frames.
}
\description{
Return the given data frame with in-frame or out-of-frame sequences only. Nucleotide sequences in a column "CDR3.nucleotide.sequence" are checked if
they length are divisible by 3 (len mod 3 == 0 => in-frame, else out-of-frame)
}