Switch to unified view

a b/man/FromDataParam-methods.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/fromDataSimParam.R
3
\docType{methods}
4
\name{FromDataParam}
5
\alias{FromDataParam}
6
\alias{FromDataParam,missing,character-method}
7
\alias{FromDataParam,survreg,character-method}
8
\title{Method to create FromDataSimParam objects}
9
\usage{
10
FromDataParam(object, type, ...)
11
12
\S4method{FromDataParam}{survreg,character}(object, type)
13
14
\S4method{FromDataParam}{missing,character}(object, type, rate, shape,
15
  sigma = matrix(c(0, 0, 0, 0), nrow = 2))
16
}
17
\arguments{
18
\item{object}{The object to derive the fromDataParam}
19
20
\item{type}{The type argument to be used in the FromDataSimParam type slot}
21
22
\item{...}{Additional options to be passed into the function}
23
24
\item{rate}{The (mean) Weibull/loglogistic rate parameter for the simulations}
25
26
\item{shape}{The (mean) Weibull/loglogistic shape parameter for the simulations}
27
28
\item{sigma}{Advanced: The covariance (uncertainty) matrix used to sample single
29
simulation rates and shapes. The covariance matrix describes the uncertainty of
30
{-log(rate),-log(shape)} - i.e. the var matrix of a survreg Weibull/loglogistic survival model}
31
}
32
\description{
33
Method to create FromDataSimParam objects
34
35
Create FromDataSimParam object from survreg model
36
}
37