File: column.summary.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 (45 lines) | stat: -rw-r--r-- 1,734 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stats.R
\name{column.summary}
\alias{column.summary}
\alias{insertion.stats}
\title{Columns statistics.}
\usage{
column.summary(.data, .factor.col, .target.col, .alphabet = NA, .remove.neg = T)

insertion.stats(.data)
}
\arguments{
\item{.data}{Data frame with columns \code{.factor.col} and \code{target.col}}

\item{.factor.col}{Columns with factors by which the data will be divided to subsets.}

\item{.target.col}{Column with numeric values for computing summaries after dividing the data to subsets.}

\item{.alphabet}{Character vector of factor levels. If NA than use all possible elements frim the \code{.factor.col} column.}

\item{.remove.neg}{Remove all elements which >-1 from the \code{.target.col} column.}
}
\value{
Data.frame with first column with levels of factors and 5 columns with output from the \code{summary} function.
}
\description{
\code{column.summary} - general function for computing summary statistics (using the \code{summary} function) for columns of the given mitcr data.frame:
divide \code{.factor.column} by factors from \code{.alphabet} and compute statistics
of correspondingly divided \code{.target.column}.

\code{insertion.stats} - compute statistics of insertions for the given mitcr data.frame.
}
\examples{
\dontrun{
# Compute summary statistics of VD insertions
# for each V-segment using all V-segments in the given data frame.
column.summary(immdata[[1]], 'V.gene', 'Total.insertions')
# Compute summary statistics of VD insertions for each V-segment using only V-segments
# from the HUMAN_TRBV_MITCR
column.summary(immdata[[1]], 'V.gene', 'Total.insertions', HUMAN_TRBV_MITCR)
}
}
\seealso{
\link{summary}
}