17 | 18 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,43 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/callCIN.R |
|
3 |
+\name{callCIN} |
|
4 |
+\alias{callCIN} |
|
5 |
+\title{Call Chromosomal Instability} |
|
6 |
+\usage{ |
|
7 |
+callCIN(res, id = 1, allele.specific = TRUE, |
|
8 |
+ reference.state = c("dominant", "normal")) |
|
9 |
+} |
|
10 |
+\arguments{ |
|
11 |
+\item{res}{Return object of the \code{\link{runAbsoluteCN}} function.} |
|
12 |
+ |
|
13 |
+\item{id}{Candidate solution to extract CIN from. \code{id=1} will use the |
|
14 |
+maximum likelihood solution.} |
|
15 |
+ |
|
16 |
+\item{allele.specific}{Use allele-specific or only total copy number for |
|
17 |
+detecting abnormal regions. Copy-number neutral LOH would be ignored when |
|
18 |
+this parameter is set to \code{FALSE}.} |
|
19 |
+ |
|
20 |
+\item{reference.state}{Copy number regions different from the reference |
|
21 |
+state are counted as abnormal. Default is \code{dominant} means the most |
|
22 |
+common state. The other option is \code{normal}, which defines normal |
|
23 |
+heterozygous, diploid as reference. The default is robust to errors in |
|
24 |
+ploidy.} |
|
25 |
+} |
|
26 |
+\value{ |
|
27 |
+Returns \code{double(1)} with CIN value. |
|
28 |
+} |
|
29 |
+\description{ |
|
30 |
+This function provides detailed CIN information. |
|
31 |
+} |
|
32 |
+\examples{ |
|
33 |
+ |
|
34 |
+data(purecn.example.output) |
|
35 |
+head(callCIN(purecn.example.output)) |
|
36 |
+ |
|
37 |
+} |
|
38 |
+\seealso{ |
|
39 |
+\code{\link{runAbsoluteCN}} |
|
40 |
+} |
|
41 |
+\author{ |
|
42 |
+Markus Riester |
|
43 |
+} |