home *** CD-ROM | disk | FTP | other *** search
/ Big Green CD 8 / BGCD_8_Dev.iso / NEXTSTEP / UNIX / Educational / R-0.49-MI / R-0.49-M / help / survival4 / survsum < prev    next >
Encoding:
Text File  |  1997-09-13  |  4.6 KB  |  135 lines
  1.     
  2.     _K_a_p_l_a_n-_M_e_i_e_r _s_u_r_v_i_v_a_l _c_u_r_v_e _a_n_d _p_e_r_c_e_n_t_a_g_e_s _a_t _s_e_l_e_c_t_e_d
  3.     _t_i_m_e_s _C_a_l_c_u_l_a_t_e_s _K_a_p_l_a_n-_M_e_i_e_r _s_u_r_v_i_v_a_l _p_e_r_c_e_n_t_a_g_e_s, _s_t_a_n_d_a_r_d
  4.     _e_r_r_o_r, _a_n_d _n_u_m_b_e_r _a_t _r_i_s_k _a_t _s_p_e_c_i_f_i_e_d _t_i_m_e_s _f_o_r _d_e_f_i_n_e_d
  5.     _g_r_o_u_p_s.  _T_e_s_t _f_o_r _d_i_f_f_e_r_e_n_c_e _b_e_t_w_e_e_n _s_u_r_v_i_v_a_l _c_u_r_v_e_s.
  6.     
  7.          survsum(formula, data=sys.parent(), sptms=NULL, xlim,
  8.          tlines=T, log=F, xscale=1,yscale=100, mark.time=F, mark=3,
  9.          cex=1, xlab="Time", ylab="Survival (%)", lgd="bl",
  10.          ttl="K-M Survival",...)
  11.     
  12.     _A_r_g_u_m_e_n_t_s:
  13.     
  14.           formula:
  15.          a formula expression as for other survival models, of
  16.          the  form Surv(time,  status) ~ predictors.  Same for-
  17.          mula expression as used in 'survfit'. See help file for
  18.          survfit.  Maximum of 6 groups.
  19.     
  20.              data:
  21.          a data.frame in which to interpret the variables named
  22.          in the formula.
  23.     
  24.             sptms:
  25.          a specified vector of positive times at which to com-
  26.          pute the survival percentages, standard errors, and
  27.          numbers at risk.  A maximum of four times can be speci-
  28.          fied.
  29.     
  30.              xlim:
  31.          a vector of the form: c(x1,x2).  The approximate
  32.          minimum and maximum values to  be  put  on  x-axis.
  33.          Default sets x1=0 and x2=maximum time value.
  34.     
  35.            tlines:
  36.          a logical value indicating whether vertical lines and
  37.          labels should be drawn on the plot at the specified
  38.          times.
  39.     
  40.               log:
  41.          logical value: should the y axis be on a log scale?
  42.     
  43.            xscale:
  44.          a scalar to be used to divide the x axis.  A value of
  45.          365, for instance, would be used to convert from days
  46.          to years.
  47.     
  48.            yscale:
  49.          a scalar to be used to multiply the y axis.  The
  50.          default value of 100 is used to get a percent scale.
  51.          'yscale=1' would set the y axis from 0 to 1.
  52.     
  53.         mark.time:
  54.          controls the labeling of the curves.  If set to True
  55.          then curves are marked at each censoring time.  If
  56.          mark.time is a numeric vector, then curves are marked
  57.          at these specified time points.
  58.     
  59.              mark:
  60.          vector of mark parameters, which will be used to  label
  61.          the  curves.  The vector is resued cyclically if it  is
  62.          shorter than the number of curves.
  63.     
  64.               cex:
  65.          parameter available to change the size of "mark".   Not
  66.          a vector; all marks have the same size.
  67.     
  68.              xlab:
  69.          character string label for the x axis.
  70.     
  71.              ylab:
  72.          character string label for the y axis.
  73.     
  74.               lgd:
  75.          legend placement.  "tr"=top right corner of the plot,
  76.          "under"=under the plot, "n" omits the legend.  The
  77.          default is: "bl"=bottom left corner of the plot.
  78.     
  79.               ttl:
  80.          title to be printed in the center top.
  81.     
  82.          In addition, the high-level graphics arguments
  83.          described under par and the arguments to title may be
  84.          supplied to this function.
  85.     
  86.          Value:
  87.     
  88.          A list of class "htest", containing the following com-
  89.          ponents:
  90.     
  91.       no.pts:
  92.     the total number of data points in each group.
  93.     
  94.     no.events:
  95.     the total number of events in each group.
  96.     
  97.        chisq:
  98.     the chisquare statistic for the test of a difference between
  99.     survival curves.
  100.     
  101.            p:
  102.     the p-value for the above test.
  103.     
  104.           t1:
  105.     a matrix containing the survival percentages, standard
  106.     errors, and numbers at risk for all groups at time t1.
  107.     
  108.     t2,t3,t4:
  109.     see above.
  110.     
  111.          A plot with multiple survival curves is drawn (one for
  112.          each group). This plot includes: overall group statis-
  113.          tics and group statistics at each specified time point
  114.          and a test for a difference between survival curves.
  115.          The total number of points and events is reported for
  116.          each group.  For each specified time point, group sur-
  117.          vival percentages (followed by standard error and
  118.          number left at risk) are computed.  The test for a
  119.          difference bewteen survival curves uses the chisquare
  120.          statistic from the 'survdiff' function with rho=0.
  121.          This is the log-rank test.
  122.     
  123.          Mark Dietrich, Mayo Clinic Section of Medical Research
  124.          Statistics summer student 1992.
  125.     
  126.          Surv survdiff survexp survfit
  127.     
  128.     _E_x_a_m_p_l_e_s:
  129.     
  130.          survsum (Surv (futime,dead)~sex+dose,data=blood.Dat,sptms=c(20,30,45),
  131.          xlim=c(0,50))
  132.          ##groups are all combinations of 'sex' and 'dose', specified times are 20, 30,
  133.          and 45.
  134.     
  135.