Downloads: 1
Diff of
/man/DisplayOptions-class.Rd
[000000]
..
[f2e496]
Switch to unified view
| a | b/man/DisplayOptions-class.Rd | ||
|---|---|---|---|
| 1 | % Generated by roxygen2: do not edit by hand |
||
| 2 | % Please edit documentation in R/displayOptions.R |
||
| 3 | \docType{class} |
||
| 4 | \name{DisplayOptions-class} |
||
| 5 | \alias{DisplayOptions-class} |
||
| 6 | \title{Class defining display options for predict from parameter graphs} |
||
| 7 | \description{ |
||
| 8 | Class defining display options for predict from parameter graphs |
||
| 9 | } |
||
| 10 | \section{Slots}{ |
||
| 11 | |||
| 12 | \describe{ |
||
| 13 | \item{\code{Time}}{string displaying the time units} |
||
| 14 | |||
| 15 | \item{\code{Title}}{string title to be displayed on the graph} |
||
| 16 | |||
| 17 | \item{\code{StartDate}}{if `0' the x-axis is labelled using 0,1,2,... |
||
| 18 | if a date is used then the x-axis is labelled with dates} |
||
| 19 | |||
| 20 | \item{\code{Control}}{legend text for control arm} |
||
| 21 | |||
| 22 | \item{\code{Exp}}{legend text for experimetal arm} |
||
| 23 | |||
| 24 | \item{\code{Trecruit}}{logical in \code{summary} output number recruited} |
||
| 25 | |||
| 26 | \item{\code{Tratio}}{logical in \code{summary} output recruitment ratio} |
||
| 27 | |||
| 28 | \item{\code{Tacc}}{logical in \code{summary} output recruit details} |
||
| 29 | |||
| 30 | \item{\code{Tmedian}}{logical in \code{summary} output control median} |
||
| 31 | |||
| 32 | \item{\code{Thr}}{logical in \code{summary} output hazard ratio} |
||
| 33 | |||
| 34 | \item{\code{Tcrithr}}{logical in \code{summary} output critical hazard ratio} |
||
| 35 | |||
| 36 | \item{\code{text.width}}{numeric in \code{summary} the width for the summary text} |
||
| 37 | |||
| 38 | \item{\code{ShowRec}}{logical. Show the number of subjects recruited at target times} |
||
| 39 | |||
| 40 | \item{\code{Dropout}}{logical. Show the drop out details} |
||
| 41 | |||
| 42 | \item{\code{atRiskTime}}{string displayin the units of at risk,} |
||
| 43 | |||
| 44 | \item{\code{atRiskConversion}}{numeric, factor for converting Time into atRiskTime} |
||
| 45 | |||
| 46 | \item{\code{showatRisk}}{logical should the at risk details be output} |
||
| 47 | }} |
||
| 48 |