File: cover.plot.Rd

package info (click to toggle)
r-cran-eipack 0.2-2-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 476 kB
  • sloc: ansic: 1,155; makefile: 5
file content (49 lines) | stat: -rw-r--r-- 1,945 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
\name{cover.plot}
\alias{cover.plot}
\alias{coverage}
\title{Unit-level coverage plots for beta parameters from MD EI model}

\description{Generates a plot of central credible intervals for the
  unit-level beta parameters from the Multinomial-Dirichlet ecological inference model
  (see \code{\link{ei.MD.bayes}}).} 

\usage{
cover.plot(object, row, column, x = NULL, CI = 0.95,
          medians = TRUE, col = NULL, ylim = c(0,1), 
          ylab, lty = par("lty"), lwd = par("lwd"), ...) 
}

\arguments{
  \item{object}{output from \code{\link{ei.MD.bayes}}}
  \item{row}{a character string specifying the row marginal of interest}
  \item{column}{a character string specifying the column marginal of
    interest}
  \item{x}{an optional covariate to index the units along the x-axis}
  \item{CI}{a fraction between 0 and 1 (defaults to 0.95), specifying
    the coverage of the central credible interval to be plotted for each unit}
  \item{medians}{a logical value specifying whether to plot the median
    (defaults to \code{TRUE}).  If \code{medians = FALSE}, the medians
    are not plotted.}
  \item{col}{an optional vector of colors to be passed to
    \code{plot} and \code{segments}.  If \code{col} is of
    length two, then the first color is used for \code{plot} and the
    second for \code{segments}.}
  \item{ylim}{an optional range for the y-axis (defaults to \code{c(0,1)}).}
  \item{ylab}{an optional label for the y-axis (defaults to
    \code{Proportion of row in column}).} 
  \item{lty}{an optional line type passed to \code{segments}.}
  \item{lwd}{an optional line width argument passed to
    \code{segments}.}
  \item{...}{additional arguments passed to \code{plot}.}
}
\value{
  A plot with vertical intervals indicating the central credible
  intervals for each ecological unit.  
}
\seealso{\code{plot}, \code{segments}, \code{par}}

\author{
  Olivia Lau <\email{olivia.lau@post.harvard.edu}>
}

\keyword{hplot}