yat  0.21pre
Public Member Functions | Friends | List of all members
theplu::yat::statistics::KaplanMeier::TimePoint Class Reference

#include <yat/statistics/KaplanMeier.h>

Public Member Functions

 TimePoint (void)
 
 TimePoint (unsigned int event, unsigned int censored)
 
unsigned int at_risk (void) const
 
unsigned int censored (void) const
 
unsigned int event (void) const
 
double survival_proportion (void) const
 

Friends

class KaplanMeier
 

Detailed Description

Class representing a time point in a kaplan-meier estimator

Constructor & Destructor Documentation

◆ TimePoint() [1/2]

theplu::yat::statistics::KaplanMeier::TimePoint::TimePoint ( void  )

Default constructor

◆ TimePoint() [2/2]

theplu::yat::statistics::KaplanMeier::TimePoint::TimePoint ( unsigned int  event,
unsigned int  censored 
)
Parameters
eventnumber of events occuring at this time point
censorednumber of data points being censored at this time point.

Member Function Documentation

◆ at_risk()

unsigned int theplu::yat::statistics::KaplanMeier::TimePoint::at_risk ( void  ) const

Number of subjects being at risk at this point in time, i.e., number of data points that occur or are being censored at this time point or later.

◆ censored()

unsigned int theplu::yat::statistics::KaplanMeier::TimePoint::censored ( void  ) const

Number of data points being censored at this time point

◆ event()

unsigned int theplu::yat::statistics::KaplanMeier::TimePoint::event ( void  ) const

Number of events occurring

◆ survival_proportion()

double theplu::yat::statistics::KaplanMeier::TimePoint::survival_proportion ( void  ) const
Returns
an estimate of proportions of samples alive.

The proportion is estimated as $ s(t) \prod_{i:t_i\le t} \left( 1 - \frac{x_i}{n_i} \right) $, where $d_i$ is number of events at time $t_i$ and $ n_i $ is subjects at risk at time $ t_i$ (see at_risk()).


The documentation for this class was generated from the following file:

Generated on Wed Jan 25 2023 03:34:29 for yat by  doxygen 1.8.14