File: kmer.table.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 (47 lines) | stat: -rw-r--r-- 1,688 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
42
43
44
45
46
47
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/kmers.R
\name{kmer.table}
\alias{kmer.table}
\alias{get.kmer.column}
\title{Make and manage the table of the most frequent k-mers.}
\usage{
kmer.table(.data, .heads = c(10, 100, 300, 1000, 3000, 10000, 30000), .k = 5, .nrow = 20,
           .clean = T, .meat = F)

get.kmer.column(.kmer.table.list, .head)
}
\arguments{
\item{.data}{tcR data.frame or a list with tcR data.frames.}

\item{.heads}{Vector of parameter for the \code{head()} function, supplied sequentialy to the \code{get.kmers()} function. -1 means all rows.}

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

\item{.nrow}{How many most frequent k-mers include to the output table.}

\item{.clean}{Parameter for the \code{get.kmers()} function.}

\item{.meat}{Parameter for the \code{get.kmers()} function.}

\item{.kmer.table.list}{Result from the \code{kmer.table} function if \code{.data} supplied as a list.}

\item{.head}{Which columns with this head return.}
}
\value{
\code{kmer.table} - if \code{.data} is a data frame, than data frame with columns like "Kmers.X", "Count.X" where X - element from \code{.heads}.
If \code{.data} is a list, than list of such data frames.

\code{get.kmer.column} - data frame with first column with kmers and other columns named as a names of data frames, from which \code{.kmer.table.list}
was generated.
}
\description{
\code{kmer.table} - generate table with the most frequent k-mers.

\code{get.kmer.column} - get vector of k-mers from the k-mer table from the function \code{kmer.table}
}
\examples{
\dontrun{
twb.kmers <- kmer.table(twb, .heads = c(5000, 10000), .meat = T)
head(get.kmer.column(twb.kmers, 10000))
}
}