File: draw.density.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (50 lines) | stat: -rw-r--r-- 1,526 bytes parent folder | download | duplicates (5)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  density.EXTS.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


\name{draw.density}
\alias{draw.density}

\title{Draws a density curve}

\description{
 Draws a density curve along one of the sides of the current plotting region.
}

\usage{
\method{draw}{density}(object, side=1, height=0.2, offset=0, scale=c("absolute", "relative"), xtrim=NULL,
  xpd=TRUE, ...)
}

\arguments{
 \item{side}{An \code{\link[base]{integer}} specifying which side to draw along.
   See \code{\link[graphics]{mtext}} for details.}
 \item{height}{A \code{\link[base]{numeric}} scalar specifying the "height" of the curve,
   where height means the maximum height of the density.
   that is, how much the zero-density position should be shifted.}
 \item{scale}{A \code{\link[base]{character}} specifying the scale of the curve, which
   can be either absolute or relative.}
 \item{xpd}{If \code{\link[base:logical]{TRUE}}, the curve is not clipped, cf. \code{\link[graphics]{par}}.}
 \item{...}{Not used.}
}

\value{
  Returns the drawn 'density' object
  (with the 'x' and 'y' coordinates as plotted).
}

\author{Henrik Bengtsson}

\seealso{
  See \code{\link[stats]{density}} for estimating densities.
  Internally \code{\link[R.utils:swapXY.density]{*swapXY}()} may be used.
}


\keyword{methods}
\keyword{internal}