File: autoplotTAP.Rd

package info (click to toggle)
r-cran-survmisc 0.5.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 504 kB
  • sloc: makefile: 5
file content (54 lines) | stat: -rwxr--r-- 1,592 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/autoplotTAP.R
\name{autoplotTableAndPlot}
\alias{autoplotTableAndPlot}
\alias{autoplot.tableAndPlot}
\title{Arrange a survival plot with corresponding table and legend.}
\usage{
\method{autoplot}{tableAndPlot}(object, ..., hideTabLeg = TRUE, tabHeight = 0.25)
}
\arguments{
\item{object}{An object of class \code{"tableAndPlot"}, as returned by
\code{ggplot.Ten}.}

\item{...}{Additional arguments (not implemented).}

\item{hideTabLeg}{Hide table legend.
\cr
If \code{hideTabLeg = TRUE} (the default), the table legend will not appear.}

\item{tabHeight}{Table height, as a fraction/ proportion of the whole.
 \cr
\code{tabHeight=0.25} (the default) makes the table 
\eqn{0.25 = 25\%} of the whole plot height.}
}
\value{
A graph, plotted with \code{gridExtra::grid.arrange}.
}
\description{
Arrange a survival plot with corresponding table and legend.
}
\details{
Arguments to \code{plotHeigth} and \code{tabHeight} are
best specified as fractions adding to \eqn{1},
\cr
}
\note{
This method is called by \code{\link{print.tableAndPlot}}
and by \code{print.stratTableAndPlot}.
}
\examples{
\dontrun{
data("kidney", package="KMsurv")
autoplot(survfit(Surv(time, delta) ~ type, data=kidney), type="fill")
autoplot(ten(survfit(Surv(time, delta) ~ type, data=kidney)), type="fill")
data("bmt", package="KMsurv")
s2 <- survfit(Surv(time=t2, event=d3) ~ group, data=bmt)
autoplot(s2)
}
}
\author{
Chris Dardis. Based on existing work by
R. Saccilotto, Abhijit Dasgupta, Gil Tomas and Mark Cowley.
}
\keyword{graphics}