flip-methods              package:NADA              R Documentation

_M_e_t_h_o_d_s _f_o_r _f_u_n_c_t_i_o_n _f_l_i_p _i_n _P_a_c_k_a_g_e _N_A_D_A

_D_e_s_c_r_i_p_t_i_o_n:

     Methods for function 'flip' in package 'NADA'.

     When used in concert with 'Cen', 'flip'  rescales left-censored
     data into right-censored data for use in the survival package
     routines (which can only handle right-censored data sets).

_U_s_a_g_e:

     ## S4 method for signature 'Cen':
     flip(x)

     ## S4 method for signature 'formula':
     flip(x)

_A_r_g_u_m_e_n_t_s:

       x: A 'Cen' or 'formula' object.

_N_o_t_e_s:

     Flips, or rescales a 'Cen' object or a formula object.

     By default, 'flip' rescales the input data by subtracting a large
     constant that is larger than maximum input value from all
     observations.  It then marks the data as right censored so that
     routines from the 'survival' package can be used.

     IMPORTANT: All NADA routines transparently handle flipping and
     re-transforming data.  Thus, 'flip' should almost never be used,
     except perhaps in the development of an extension function.

     Also, flipping a Cen object results in a Surv object -  which
     presently cannot be flipped back to a Cen object!

     Flipping a formula just symbolically updates the  response (which
     should be a Cen object).  Result is like: flip(Cen(obs,
     cen))~groups

