File: add.broad.peak.regions.Rd

package info (click to toggle)
r-cran-spp 1.15.5-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 572 kB
  • sloc: cpp: 3,314; ansic: 365; makefile: 2
file content (27 lines) | stat: -rw-r--r-- 1,189 bytes parent folder | download | duplicates (2)
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
\name{add.broad.peak.regions}
\alias{add.broad.peak.regions}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{ Calculate chromosome-wide profiles of smoothed tag density }
\description{
  Looks for broader regions of enrichment associated with the determined
  peak positions, adds them to the $npl data as $rs, $re columns. 
}
\usage{
add.broad.peak.regions(chip.tags,input.tags,bp,window.size=500,z.thr=2)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{chip.tags}{ signal chromosome tag coordinate vectors (e.g. output
    of \code{\link{select.informative.tags}} }
  \item{input.tags}{ optionall control (input) tags }
  \item{bp}{ output of find.binding.positions call }
  \item{window.size}{ window size to be used in calculating enrichment }
  \item{z.thr}{ Z-score corresponding to the Poisson ratio threshold
    used to flag significantly enriched windows}
}
\value{
  A structure identical to bp (binding.postions) with two additional columns
  added (rs and re) corresponding to start and end of the associated
  significantly enriched region. If no region was associated with a
  particular peak, NAs values are reported.
}