File: get.smoothed.enrichment.mle.Rd

package info (click to toggle)
r-cran-spp 1.16.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, trixie
  • size: 576 kB
  • sloc: cpp: 3,310; ansic: 365; makefile: 2
file content (58 lines) | stat: -rw-r--r-- 2,307 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
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
\name{get.smoothed.enrichment.mle}
\alias{get.smoothed.enrichment.mle}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{ Calculate chromosome-wide profiles of smoothed enrichment estimate }
\description{
  Given signal and control tag positions, the method calculates log2
  signal to control enrichment esimates (maximum likelihood) for each
  chromosome, based on the smoothed tag density profile (see \link{get.smoothed.tag.density}).
}
\usage{

get.smoothed.enrichment.mle(signal.tags, 
  control.tags, 
  tag.shift = 146/2, 
  background.density.scaling = F, 
  pseudocount = 1,
  bg.weight = NULL, 
  rngl = NULL, 
  chrl = NULL, 
  ...)

}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{signal.tags}{ signal chromosome tag coordinate vectors (e.g. output
    of \code{\link{select.informative.tags}} }
  \item{control.tags}{ control (input) tags }
  \item{tag.shift}{ number of base pairs by which positive and negative
    tag coordinates should be shifted towards eachother (half of binding
    peak separation distance)}
  \item{background.density.scaling}{background.density.scaling}
  \item{pseudocount}{ pseudocount value to be added to tag density -
    defaults to 1 }
  \item{bg.weight}{ optional weight by which the background density
    should be multipled for scaling. If not supplied, the weight is
    calculated based on the ratio of the reduced ChIP to input dataset sizes. }
  \item{rngl}{rngl}
  \item{chrl}{chrl}
  \item{\dots}{ additional parameters should be the same as those passed
      to the \code{\link{get.smoothed.tag.density}}, such as for example
      bandwidth (default value 150) and step (default value 50).
      see appropriate reference for
      \code{\link{get.smoothed.tag.density}} for details.}
}
\value{
  A list of elements corresponding to chromosomes, with each element
  being an $x/$y data.frame giving the position and associated
  log2 signal/control enrichment estimate. 
}
\seealso{ \code{\link{writewig}} }
\examples{
\dontrun{
  # get smoothed enrichment estimate profile using 500bp bandwidth at
  # 50bp steps
  smoothed.M <- get.smoothed.enrichment.mle(chip.data,bandwidth=500,step=50);
  writewig(smoothed.M,"example.smoothedM.wig","Example smoothed log2 intensity ratio estimate");
  }
}