survcheck

0th

Percentile

Checks of a survival data set

Perform a set of consistency checks on survival data

Keywords
survival
Usage
survcheck(formula, data, id, istate, istate0="(s0)", timefix=TRUE,...)
Arguments
formula

a model formula with a Surv object as the response

data

data frame in which to find the id, istate and formula variables

id

an identifier that labels unique subjects

istate

an optional vector giving the initial state for each observation, i.e., the state at the start of each interval

istate0

default label for the initial state when istate is missing

timefix

process times through the aeqSurv function to eliminate potential roundoff issues.

other arguments, which are ignored (but won't give an error if someone added weights for instance)

Details

This routine will examine a multi-state data set for consistency of the data. The basic rules are that if a subject is at risk they have to be somewhere, can not be two states at once, and should make sensible transitions from state to state. It reports the number of instances of the following conditions:

overlap

two observations for the same subject that overlap in time, e.g. intervals of (0, 100) and (90, 120). If y is simple (time, status) survival observation intervals implicitly start at 0, so in that case any duplicate identifiers will generate an overlap.

jump

a hole in a subject's timeline, where they are in one state at the end of the prior interval, but a new state in the at the start subsequent interval.

gap

one or more gaps in a subject's timeline; they are presumably in the same state at their return as when they left.

teleport

two adjacent intervals for a subject, with the first interval ending in one state and the subsequent interval starting in another. They have instantaneously changed states with experiencing a transition.

The total number of occurences of each is present in the flags vector. Optional components give the location and identifiers of the flagged observations.

Value

a list with components

states

the vector of possible states

transitions

a matrix giving the count of transitions from one state to another

statecount

table of the number of visits per state, e.g., 18 subjects had 2 visits to the "infection" state

flags

a vector giving the counts of each check

istate

a revised initial state vector

overlap

a list with the row number and id of overlaps (not present if there are no overlaps)

gaps

a list with the row number and id of gaps (not present if there are no gaps)

teleport

a list with the row number and id of inconsistent rows (not present if there are none)

jumps

a list with the row number and id of jumps (not present if there are no jumps

Aliases
  • survcheck
Documentation reproduced from package survival, version 3.1-8, License: LGPL (>= 2)

Community examples

Looks like there are no examples yet.