forked from lima1/PureCN
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcalculateLogRatio.Rd
39 lines (36 loc) · 1.13 KB
/
calculateLogRatio.Rd
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/calculateLogRatio.R
\name{calculateLogRatio}
\alias{calculateLogRatio}
\title{Calculate coverage log-ratio of tumor vs. normal}
\usage{
calculateLogRatio(normal, tumor)
}
\arguments{
\item{normal}{Normal coverage read in by the \code{\link{readCoverageFile}}
function.}
\item{tumor}{Tumor coverage read in by the \code{\link{readCoverageFile}}
function.}
}
\value{
\code{numeric(length(tumor))}, tumor vs. normal copy number log-ratios
for all targets.
}
\description{
This function is automatically called by \code{\link{runAbsoluteCN}} when
normal and tumor coverage are provided (and not a segmentation file or
target-level log-ratios). This function is therefore normally not called by
the user.
}
\examples{
normal.coverage.file <- system.file("extdata", "example_normal.txt.gz",
package = "PureCN")
tumor.coverage.file <- system.file("extdata", "example_tumor.txt.gz",
package = "PureCN")
normal <- readCoverageFile(normal.coverage.file)
tumor <- readCoverageFile(tumor.coverage.file)
log.ratio <- calculateLogRatio(normal, tumor)
}
\author{
Markus Riester
}