|
a |
|
b/man/find_peaks_near_genes.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/bipartites.R |
|
|
3 |
\name{find_peaks_near_genes} |
|
|
4 |
\alias{find_peaks_near_genes} |
|
|
5 |
\title{Associate peaks to genes based on distance to TSS (or gene body)} |
|
|
6 |
\usage{ |
|
|
7 |
find_peaks_near_genes( |
|
|
8 |
peaks, |
|
|
9 |
genes, |
|
|
10 |
sep = c("-", "-"), |
|
|
11 |
method = c("Signac", "GREAT"), |
|
|
12 |
upstream = 1e+05, |
|
|
13 |
downstream = 0, |
|
|
14 |
extend = 1e+06, |
|
|
15 |
only_tss = FALSE, |
|
|
16 |
verbose = TRUE |
|
|
17 |
) |
|
|
18 |
} |
|
|
19 |
\arguments{ |
|
|
20 |
\item{peaks}{vector(character) - List of peaks.} |
|
|
21 |
|
|
|
22 |
\item{genes}{vector(character) - List of genes.} |
|
|
23 |
|
|
|
24 |
\item{sep}{vector(character) - Separator between chromosome, |
|
|
25 |
start and end position. Default: c('-', '-').} |
|
|
26 |
|
|
|
27 |
\item{method}{(character) - Method to use. Default: "Signac". |
|
|
28 |
\itemize{ |
|
|
29 |
\item \code{'Signac'} - Use Signac::Extend to extend genes. |
|
|
30 |
\item \code{'GREAT'} - Not implemented yet. |
|
|
31 |
}} |
|
|
32 |
|
|
|
33 |
\item{upstream}{(int) - Upstream distance from TSS |
|
|
34 |
to consider as potential promoter.} |
|
|
35 |
|
|
|
36 |
\item{downstream}{(int) - Downstream distance from TSS |
|
|
37 |
to consider as potential promoter.} |
|
|
38 |
|
|
|
39 |
\item{extend}{(int) - Integer defining the distance from the upstream |
|
|
40 |
and downstream of the basal regulatory region. Used only by method 'GREAT'.} |
|
|
41 |
|
|
|
42 |
\item{only_tss}{(logical) - If TRUE, only TSS will be considered.} |
|
|
43 |
|
|
|
44 |
\item{verbose}{(logical) - If TRUE, print progress messages.} |
|
|
45 |
} |
|
|
46 |
\value{ |
|
|
47 |
(matrix) - Matrix of peaks x genes with 1 if peak is near gene. |
|
|
48 |
} |
|
|
49 |
\description{ |
|
|
50 |
Associate peaks to genes based on distance to TSS (or gene body) |
|
|
51 |
} |
|
|
52 |
\examples{ |
|
|
53 |
TODO |
|
|
54 |
} |