fHTEST              package:fUtilities              R Documentation

_T_e_s_t_s _C_l_a_s_s _R_e_p_r_e_s_e_n_t_a_t_i_o_n _a_n_d _U_t_i_l_i_t_i_e_s

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

     Class representation, methods and utility  functions for objects
     of class 'fHTEST'. 

     The class representation and methods are:

       'fHTEST'  Representation for an S4 object of class "fHTEST",
       'show'    S4 print method.

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

     show.fHTEST(object)

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

  object: [show] - 
           an S4 object of class '"fHTEST"'. 

_V_a_l_u_e:

     In contrast to R's output report from S3 objects of class
     '"htest"' a different output report is produced. The tests return
     an S4 object  of class '"fHTEST"'. The object contains the
     following slots:

   @call: the function call.   

   @data: the data as specified by the input argument(s). 

   @test: a list whose elements contail the results from the
          statistical test. The information provided is similar to a
          list object of class{"htest"}. 

  @title: a character string with the name of the test. This can be 
          overwritten specifying a user defined input argument. 

@description: a character string with an optional user defined
          description.  By default just the current date when the test
          was applied will be returned.

statistic: the value(s) of the test statistic. 

 p.value: the p-value(s) of the test. 

parameters: a numeric value or vector of parameters. 

estimate: a numeric value or vector of sample estimates. 

conf.int: a numeric two row vector or matrix of 95 

  method: a character string indicating what type of test was
          performed. 

data.name: a character string giving the name(s) of the data. 

_E_x_a_m_p_l_e_s:

     ## fHTEST -
        getClass("fHTEST")
        getSlots("fHTEST")

