|
a |
|
b/man/LatexSurvivalFn-methods.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/sfn.R, R/results.R |
|
|
3 |
\docType{methods} |
|
|
4 |
\name{LatexSurvivalFn} |
|
|
5 |
\alias{LatexSurvivalFn} |
|
|
6 |
\alias{LatexSurvivalFn,AnalysisResults-method} |
|
|
7 |
\alias{LatexSurvivalFn,Sfn-method} |
|
|
8 |
\title{Method to output a Latex String of the object} |
|
|
9 |
\usage{ |
|
|
10 |
LatexSurvivalFn(results, ...) |
|
|
11 |
|
|
|
12 |
\S4method{LatexSurvivalFn}{Sfn}(results, decimalplaces, lambda, shape) |
|
|
13 |
|
|
|
14 |
\S4method{LatexSurvivalFn}{AnalysisResults}(results, decimalplaces = 3) |
|
|
15 |
} |
|
|
16 |
\arguments{ |
|
|
17 |
\item{results}{Object to output} |
|
|
18 |
|
|
|
19 |
\item{decimalplaces}{The number of decimal places to output for the |
|
|
20 |
rate and shape parameters} |
|
|
21 |
|
|
|
22 |
\item{lambda}{The symbol to be used for the arm's rate |
|
|
23 |
parameter, if lagged study then this is a vector of before and after lag |
|
|
24 |
symbols. The latex backslash character needs to be escaped} |
|
|
25 |
|
|
|
26 |
\item{shape}{The symbol to be used for Weibull shape parameter} |
|
|
27 |
|
|
|
28 |
\item{\ldots}{Additional parameters to be passed into the function} |
|
|
29 |
} |
|
|
30 |
\value{ |
|
|
31 |
A latex string of the object (for \code{Sfn} this is the Survival function) |
|
|
32 |
} |
|
|
33 |
\description{ |
|
|
34 |
Method to output a Latex String of the object |
|
|
35 |
} |
|
|
36 |
|