v_rcensored provides a right-censored vector. Unlike other representations, such the survival package's Surv object, v_rcensored can be subset with [ and concatenated with c as you would any other vector. The type is implemented as a new_rcrd where the necessary data are contained in fields.

v_rcensored(
  outcomes = list(),
  censors,
  end_time = Inf,
  internal_name = "",
  context,
  extra_descriptors = list()
)

rcen(
  outcomes = list(),
  censors,
  end_time = Inf,
  internal_name = "",
  context,
  extra_descriptors = list()
)

is_v_rcensored(x)

is_rcensored(x)

# S3 method for v_rcensored
as.character(x, ...)

# S3 method for v_rcensored
as_canonical(x)

Arguments

outcomes

A list of v_event_time vectors that define the outcomes. The order of this list defines the precedence of outcomes. That is, if the first outcome and second outcome occur at the same time, the first outcome is the reason for the outcome.

censors

A list of v_event_time vectors that define the censor The order of this list defines the precedence of censoring That is, if the first censor and second censor occur at the same time, the first censor is the reason for the censoring

end_time

A numeric scalar defining the end of follow-up.

internal_name

the internal name of the variable

context

a context

extra_descriptors

A list of descriptors functions appended to the default descriptors.

x

a integer vector

...

passed to other methods such as as.character

Details

as_canonical casts the vector to a list. See v_rcensored_accessors for functions to access components of a v_rcensored.

When printed, an open right triangle indicates an observation was censored. A closed right triangle indicates an observation reached end_time without being censored or having an outcome. No triangles indicated an observation that had one of the outcomes.

See also