FLPar                 package:FLCore                 R Documentation

_C_l_a_s_s _F_L_P_a_r

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

     The 'FLPar' class is a class for storing the parameters of a
     model. It is based on  the array class which can store Monte Carlo
     samples and the names of the relevant  parameter vectors.

     Methods for this class include subsetting and replacement as they
     exist for the  'FLQuant' class. There are methods for extracting
     statistics of the sample (mean,  median etc.) and for plotting the
     parameter samples.

_S_l_o_t_s:


     ._D_a_t_a Describe slot. 'array'.

     _u_n_i_t_s Units of measurement. 'character'.

_E_x_t_e_n_d_s:



_M_e_t_h_o_d_s:


     [(_b_a_s_e) : Subsetting method to access the parameter values.

      ' signature(x=FLPar,i=ANY,j=ANY,drop=missing) '

     [<-(_b_a_s_e) : Replacement method for the parameter values.

      ' signature(x=FLPar,i=ANY,j=ANY,value=missing) '

     _a_s._d_a_t_a._f_r_a_m_e(_b_a_s_e) : Creates a data frame from the object.

      ' signature(x=FLPar,row.names=ANY,optional=ANY) '

     _d_e_n_s_i_t_y_p_l_o_t(_l_a_t_t_i_c_e) : applies the densityplot method from
          'lattice'

      ' signature(x=formula,data=FLPar) '

     _h_i_s_t_o_g_r_a_m(_l_a_t_t_i_c_e) : applies the histogram method from 'lattice'

      ' signature(x=formula,data=FLPar) '

     _i_t_e_r(_F_L_C_o_r_e) : extracts the relevant iteration for the given
          parameter sample.

      ' signature(object=missing) '

     _i_t_e_r<-(_F_L_C_o_r_e) : replacement method for the parameter iteration.

      ' signature(object=missing,value=missing) '

     _m_e_a_n(_b_a_s_e) : calculates the mean of the parameter samples.

      ' signature(x=missing) '

     _m_e_d_i_a_n(_s_t_a_t_s) : calculates the median of the parameter samples.

      ' signature(x=missing,na.rm=missing) '

     _p_l_o_t(_g_r_a_p_h_i_c_s) : default plot method for 'FLPar'

      ' signature(x=FLPar,y=missing) '

     _s_p_l_o_m(_l_a_t_t_i_c_e) : applies the splom method from 'lattice'

      ' signature(x=FLPar,data=missing) '

     _s_u_m_m_a_r_y(_b_a_s_e) : Summarises the 'FLPar' object.

      ' signature(object=missing) '

     _u_n_i_t_s(_b_a_s_e) : extracts the units of the parameters.

      ' signature(x=missing) '

     _u_n_i_t_s<-(_b_a_s_e) : replacement method for the units of the object.

      ' signature(x=FLPar,value=character) '

     _v_a_r(_s_t_a_t_s) : calculates the variance of the parameter samples.

      ' signature(x=missing,y=missing,na.rm=missing,use=missing) '

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

     The FLR Team

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

     [, [<-, as.data.frame, densityplot, histogram, iter, iter<-, mean,
     median, plot, splom, summary, units,FLPar-method,
     units<-,FLPar,character-method, var

