ranks                 package:BRugs                 R Documentation

_C_a_l_c_u_l_a_t_i_o_n _o_f _r_a_n_k_s

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

     These functions are used to calculate ranks of vector valued
     quantities in the model.

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

     ranksSet(node)
     ranksStats(node)
     ranksClear(node)

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

    node: Character, name of a vector (one dimensional array) variable
          in the model.

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

     'ranksSet' creates a monitor that starts building running
     histograms to represent  the rank of each component of 'node'.  An
     amount of storage proportional to the square of the number of
     components of 'node' is allocated.  Even for large numbers of
     components this can require less storage than calculating the
     ranks  explicitly in the model specification and storing their
     samples, and it is also much quicker.

     'ranksStats' displays summarises of the distribution of the ranks
     of each component of 'node'.

     'ranksClear' removes the monitor calculating running histograms
     for 'node'.

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

     'ranksStats' returns a data frame with columns: 

val2.5pc: 0.025 quantiles

  median: medians

val97.5pc: 0.975 quantiles

_N_o_t_e:

     Users should ensure their simulation has converged before using
     these functions.  Note that if the MCMC simulation has an adaptive
     phase it will not be possible to make  inference using values
     sampled before the end of this phase.

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

     'BRugs', 'help.WinBUGS'

