ParamFamily             package:ROptEst             R Documentation

_G_e_n_e_r_a_t_i_n_g _f_u_n_c_t_i_o_n _f_o_r _P_a_r_a_m_F_a_m_i_l_y-_c_l_a_s_s

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

     Generates an object of class '"ParamFamily"'.

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

     ParamFamily(name, distribution = Norm(), distrSymm, main = 0, 
                 nuisance, trafo, param, props = character(0))

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

    name: character string: name of family 

distribution: object of class '"Distribution"':  member of the family 

distrSymm: object of class '"DistributionSymmetry"':  symmetry of
          'distribution'. 

    main: numeric vector: main parameter 

nuisance: numeric vector: nuisance parameter 

   trafo: matrix: transformation of the parameters 

   param: object of class '"ParamFamParameter"': parameter of the
          family 

   props: character vector: properties of the family 

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

     If 'name' is missing, the default  ""parametric family of
     probability measures"" is used.  In case 'distrSymm' is missing it
     is set  to 'NoSymmetry()'. If 'param' is missing, the parameter is
     created via 'main', 'nuisance' and 'trafo' as described in
     'ParamFamParameter'.

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

     Object of class '"ParamFamily"'

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

     Matthias Kohl Matthias.Kohl@stamats.de

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

     'ParamFamily-class'

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

     F1 <- ParamFamily()
     plot(F1)

     ## The function is currently defined as
     function(name, distribution = Norm(), main = 0, nuisance, 
              trafo, param, props = character(0)){
         if(missing(name)) 
             name <- "parametric family of probability measures"
         if(missing(distrSymm)) distrSymm <- NoSymmetry()
         if(missing(param)) 
             param <- ParamFamParameter(name = paste("parameter of", name), 
                             main = main, nuisance = nuisance, trafo = trafo)
         return(new("ParamFamily", name = name, distribution = distribution, 
                    distrSymm = distrSymm, param = param, props = props))
     }

