File: permutDistTest.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 (56 lines) | stat: -rw-r--r-- 1,670 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
50
51
52
53
54
55
56
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/crosses.R
\name{permutDistTest}
\alias{permutDistTest}
\title{Monte Carlo permutation test for pairwise and one-vs-all-wise within- and inter-group differences in a set of repertoires.}
\usage{
permutDistTest(
  .mat,
  .groups,
  .n = 1000,
  .fun = mean,
  .signif = 0.05,
  .plot = T,
  .xlab = "Values",
  .title = "Monte Carlo permutation testing of overlaps",
  .hjust = -0.1,
  .vjust = -4
)
}
\arguments{
\item{.mat}{Symmetric matrix of repertoire distances.}

\item{.groups}{Named list with names of repertoires in groups.}

\item{.n}{Number of permutations for each pair of group.}

\item{.fun}{A function to apply to distances.}

\item{.signif}{Significance level. Below this value hypotheses counts as significant.}

\item{.plot}{If T than plot the output results. Else return them as a data frame.}

\item{.xlab}{X lab label.}

\item{.title}{Main title of the plot.}

\item{.hjust}{Value for adjusting the x coordinate of p-value labels on plots.}

\item{.vjust}{Value for adjusting the y coordinate of p-value labels on plots.}
}
\description{
WARNING: this is an experimental procedure, work is still in progress.

Perform permutation tests of distances among groups for the given groups of samples and matrix of distances among all samples.
}
\examples{
\dontrun{
data(twb)
mat <- repOverlap(twb)
permutDistTest(mat, list(tw1 = c('Subj.A', 'Subj.B'), tw2 = c('Subj.C', 'Subj.D')))
permutDistTest(mat, list(tw1 = c('Subj.A', 'Subj.B'), tw2 = c('Subj.C', 'Subj.D')), .fun = median)
}
}
\seealso{
\link{repOverlap}, \link{intersectClonesets}, \link{ozScore}, \link{pca2euclid}
}