File: CNEDensity.Rd

package info (click to toggle)
r-bioc-cner 1.26.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 18,216 kB
  • sloc: ansic: 23,458; makefile: 6
file content (92 lines) | stat: -rw-r--r-- 2,418 bytes parent folder | download | duplicates (4)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
\name{CNEDensity-methods}
\docType{methods}
\alias{CNEDensity}
\alias{CNEDensity-methods}
\alias{CNEDensity,ANY,character,character,missing,missing-method}
\alias{CNEDensity,ANY,missing,character,character,character-method}

\title{
  CNEDensity function
}

\description{
  This function queries the database and generates the CNEs' density values.
}

\usage{
CNEDensity(dbName, tableName, chr, start, end, 
           whichAssembly=c("first", "second"),
           windowSize=300, minLength=NULL)
}

\arguments{
  \item{dbName}{
    \code{character}(1): the path of the local SQLite database.
  }
  \item{tableName}{
    \code{character}(1): the name of table for this CNE data table.
    It can be missing when assembly1, assembly2 and threshold are provided.
  }
  \item{chr}{
     \code{character}(1): the chromosome to query.
  }
  \item{start, end}{
    \code{integer}(1): the start and end coordinate to fetch the CNEs.
  }
  \item{whichAssembly}{
    \code{character}(1):
    the genome to fetch is in the \sQuote{first} column or \sQuote{second}
    column of the table.
  }
  \item{windowSize}{
    \code{integer}(1): the window size in kb that is used to smooth the CNEs.
  }
  \item{minLength}{
    \code{integer}(1): the minimal length of CNEs to fetch.
  }
}

\section{Methods}{
\describe{

\item{\code{signature(tableName = "character",
                      assembly1 = "character", assembly2 = "missing",
                      threshold = "missing")}}{
}

\item{\code{signature(tableName = "missing", assembly1 = "character",
                      assembly2 = "character", threshold = "character")}}{
}
}}

\value{
  A \code{GRanges} object with density values is returned. 
}

\author{
  Ge Tan
}


\examples{
dbName <- file.path(system.file("extdata", package="CNEr"),
                    "danRer10CNE.sqlite")
genome <- "danRer10"
chr <- "chr6"
start <- 24000000L
end <-  27000000L
windowSize <- 200L
minLength <- 50L
cneDanRer10Hg38_45_50 <- 
  CNEDensity(dbName=dbName, 
             tableName="danRer10_hg38_45_50", 
             whichAssembly="first", chr=chr, start=start,
             end=end, windowSize=windowSize, 
             minLength=minLength)
cneDanRer10Hg38_49_50 <-
  CNEDensity(dbName=dbName, 
             tableName="danRer10_hg38_49_50", 
             whichAssembly="first", chr=chr, start=start,
             end=end, windowSize=windowSize, 
             minLength=minLength)
}