pmin_v_rcensored: Combine Right-Censored Events

View source: R/v_rcensored.R

pmin_v_rcensoredR Documentation

Combine Right-Censored Events

Description

Create a right-censored event based on the minimum time to event among a collection of right-censored events. In the event of ties for censoring or outcome events, earlier inputs are given precedence over later inputs.

Usage

pmin_v_rcensored(
  ...,
  new_end_time = "strict",
  internal_name = "",
  context = methods::new("context"),
  extra_descriptors = list()
)

Arguments

...

a collection of v_rcensored objects.

new_end_time

either one of "strict" or "min", or a postive scalar value. In the case of "strict" the inputs are assumed to all have the same end_time value (otherwise an error is thrown), and the end_time of the output object is the same as that of the inputs. In the case of "min", the minimum end_time value among all of the inputs is the taken to be the end_time of the output object. In the case of a positive scalar input for new_end_time, the end_time of the output object is taken to be the value of new_end_time. Note that an error is thrown if the value of new_end_time is larger than the smallest end_time value among the inputs since this situation could result in faulty data.

internal_name

the internal name of the variable

context

a context

extra_descriptors

A list of descriptors functions appended to the default descriptors.

Value

A v_rcensored object.


novisci/stype documentation built on July 28, 2022, 7:44 a.m.