[f2e496]: / man / FromDataParam-methods.Rd

Download this file

38 lines (28 with data), 1.3 kB

 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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/fromDataSimParam.R
\docType{methods}
\name{FromDataParam}
\alias{FromDataParam}
\alias{FromDataParam,missing,character-method}
\alias{FromDataParam,survreg,character-method}
\title{Method to create FromDataSimParam objects}
\usage{
FromDataParam(object, type, ...)
\S4method{FromDataParam}{survreg,character}(object, type)
\S4method{FromDataParam}{missing,character}(object, type, rate, shape,
sigma = matrix(c(0, 0, 0, 0), nrow = 2))
}
\arguments{
\item{object}{The object to derive the fromDataParam}
\item{type}{The type argument to be used in the FromDataSimParam type slot}
\item{...}{Additional options to be passed into the function}
\item{rate}{The (mean) Weibull/loglogistic rate parameter for the simulations}
\item{shape}{The (mean) Weibull/loglogistic shape parameter for the simulations}
\item{sigma}{Advanced: The covariance (uncertainty) matrix used to sample single
simulation rates and shapes. The covariance matrix describes the uncertainty of
{-log(rate),-log(shape)} - i.e. the var matrix of a survreg Weibull/loglogistic survival model}
}
\description{
Method to create FromDataSimParam objects
Create FromDataSimParam object from survreg model
}