check_type_outcome-internal {sMSROC}R Documentation

Check the type of scenario (diagnosis/prognosis)

Description

Determines the type of scenario handled: diagnosis or prognosis, under right or interval censorship, according to the parameters entered by the user.

Usage

check_type_outcome(status, observed.time, left, right)

Arguments

status

numeric response vector. Only two values will be taken into account. The highest one is assumed to stand for the subjects having the event under study. The lowest value, for those who do not. Any other value will not be considered.

observed.time

vector with the observed times for each subject, when dealing with time-dependent outcomes under right censorship. These values can be the event times or the censoring times.

left

vector containing the lower edges of the observed intervals. It is mandatory when dealing with prognosis scenarios and interval censorship, and will be ignored in other situations.

right

vector with the upper edges of the observed intervals. It is mandatory as well in prognosis scenarios and interval censorship and ignored in other situations.

Details

If both the vectors status and observed time are indicated the funtion assumes a prognosis scenario and right censorship. When only the vector status is entered, a diagnosis scenario is set up. If none of these parameters are indicated but the left and right ones, a prognosis scenario and interval censorship is assumed. Any other case, the function is not able to determine the type of scenario.

Value

A list with a single component:

type.outcome

string of length 6 with the following values:

  • "binout", in the case of diagnosis scenarios.

  • "timerc", for prognosis scenarios and right censorship.

  • "timeic", for prognosis scenarios and interval censorship.

  • "unknow", if it is not possible to determine the type of scenario.


[Package sMSROC version 0.1.2 Index]