pilotData                package:SSPA                R Documentation

_C_r_e_a_t_e_s _a_n _o_b_j_e_c_t _o_f _c_l_a_s_s "_P_i_l_o_t_D_a_t_a"

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

     The function 'pilotData' initializes a 'PilotData'-object.
     Information of the pilot data and the null distribution is stored
     e.g. name of pilot experiment, test statistics and number of
     samples used.

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

     pilotData(name = "Unknown Experiment", testStatistics = double(1), sampleSizeA = double(1), sampleSizeB = double(1), dof = double(0),     nullDist = c("normal", "student"))

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

    name: character string giving the experiment name

testStatistics: vector of type numeric containing the set of test
          statistics

sampleSizeA: the samplesize of group A

sampleSizeB: the samplesize of group B

     dof: degree of freedom for a Student t distribution

nullDist: distribution under the null hypothesis either one of:

             *  "normal",

             *  "student", (only in case of method="Ruppert" see
                'sampleSize')      

_D_e_t_a_i_l_s:

     Based on the given null distribution two-sided p-values are
     calculated from the test statistics. Some additional checks on the
     data are performed. Once an object of 'PilotData' is created the
     'sampleSize'-function can be called.

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

     object of class 'PilotData'

_A_u_t_h_o_r(_s):

     Maarten van Iterson

_S_e_e _A_l_s_o:

     'hist', 'plot' and 'PilotData' use 'class?PilotData'

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

     library(multtest)
     data(golub)
     teststat <- mt.teststat(golub, golub.cl)
     table(golub.cl)
     pd <- pilotData(name="golub", testStatistics=teststat, sampleSizeA=11, sampleSizeB=27)

