s_exponential: Factory of SURVIVAL objects with Exponential distributions

View source: R/exponential_class.R

s_exponentialR Documentation

Factory of SURVIVAL objects with Exponential distributions

Description

Creates a SURVIVAL object with an Exponential distribution.

Usage

s_exponential(...)

Arguments

...

Parameters to define the distribution. See the Parameters for details

Value

a SURVIVAL object of the exponential distribution family. See the documentation of s_factory for the methods available for SURVIVAL objects

Parameters

To create an exponential survival object the following options are available:

lambda to specify the canonical parameter of the distribution, or

surv and t for the proportion surviving (no events) at time t, or

fail and t for the proportion failing (events) at time t

lambda = -log(surv)/t

lambda = -log(1-fail)/t

The parameters should be spell correctly as partial matching is not available

Examples

s_exponential(lambda = 3)
s_exponential(surv = 0.4, t = 2)
s_exponential(fail = 0.6, t = 2)

survobj documentation built on Sept. 11, 2024, 7:14 p.m.