var                 package:distrEx                 R Documentation

_G_e_n_e_r_i_c _F_u_n_c_t_i_o_n _f_o_r _t_h_e _C_o_m_p_u_t_a_t_i_o_n _o_f _F_u_n_c_t_i_o_n_a_l_s

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

     Generic function for the computation of functionals on
     distributions.

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

     IQR(x, ...)

     ## S4 method for signature 'UnivariateDistribution':
     IQR(x)

     median(x, ...)

     ## S4 method for signature 'UnivariateDistribution':
     median(x)

     mad(x, ...)

     ## S4 method for signature 'UnivariateDistribution':
     mad(x)

     sd(x, ...)

     ## S4 method for signature 'UnivariateDistribution':
     sd(x, fun, cond, withCond, useApply, ...)

     var(x, ...)

     ## S4 method for signature 'UnivariateDistribution':
     var(x, fun, cond, withCond, useApply, ...)
     ## S4 method for signature 'Binom':
     var(x)
     ## S4 method for signature 'Beta':
     var(x)
     ## S4 method for signature 'Cauchy':
     var(x)
     ## S4 method for signature 'Chisq':
     var(x)
     ## S4 method for signature 'Dirac':
     var(x)
     ## S4 method for signature 'Exp':
     var(x)
     ## S4 method for signature 'Fd':
     var(x)
     ## S4 method for signature 'Gammad':
     var(x)
     ## S4 method for signature 'Geom':
     var(x)
     ## S4 method for signature 'Hyper':
     var(x)
     ## S4 method for signature 'Logis':
     var(x)
     ## S4 method for signature 'Lnorm':
     var(x)
     ## S4 method for signature 'Nbinom':
     var(x)
     ## S4 method for signature 'Norm':
     var(x)
     ## S4 method for signature 'Pois':
     var(x)
     ## S4 method for signature 'Td':
     var(x)
     ## S4 method for signature 'Unif':
     var(x)
     ## S4 method for signature 'Weibull':
     var(x)

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

       x: object of class '"UnivariateDistribution"'

     fun: if missing the (conditional) variance resp. standard
          deviation is computed else the (conditional) variance resp.
          standard deviation of 'fun' is computed. 

    cond: if not missing the conditional variance resp. standard
          deviation   given 'cond' is computed. 

     ...: additional arguments to 'fun' or 'E'

useApply: logical: should 'sapply', respectively 'apply'  be used to
          evaluate 'fund'.

withCond: logical: is 'cond' in the argument list of 'fun'. 

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

     The value of the corresponding functional at the distribution in
     the argument is computed.

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

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_A_n_y")': interface to the 'stats'-function
          'var' - see 'var'.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_U_n_i_v_a_r_i_a_t_e_D_i_s_t_r_i_b_u_t_i_o_n")': variance of
          univariate distributions using corresponding 'E()'-method.

     '_s_d', '_s_i_g_n_a_t_u_r_e(_x = "_U_n_i_v_a_r_i_a_t_e_D_i_s_t_r_i_b_u_t_i_o_n")': standard
          deviation of univariate distributions using corresponding
          'E()'-method.

     '_I_Q_R', '_s_i_g_n_a_t_u_r_e(_x = "_A_n_y")': interface to the 'stats'-function
          'IQR' - see 'IQR'.

     '_I_Q_R', '_s_i_g_n_a_t_u_r_e(_x = "_U_n_i_v_a_r_i_a_t_e_D_i_s_t_r_i_b_u_t_i_o_n")': interquartile
          range of univariate distributions using corresponding
          'q()'-method.

     '_m_e_d_i_a_n', '_s_i_g_n_a_t_u_r_e(_x = "_A_n_y")': interface to the
          'stats'-function 'median' - see 'median'.

     '_m_e_d_i_a_n', '_s_i_g_n_a_t_u_r_e(_x = "_U_n_i_v_a_r_i_a_t_e_D_i_s_t_r_i_b_u_t_i_o_n")': median of
          univariate distributions using corresponding 'q()'-method. 

     '_m_a_d', '_s_i_g_n_a_t_u_r_e(_x = "_A_n_y")': interface to the 'stats'-function
          'mad' - see 'mad'.

     '_m_a_d', '_s_i_g_n_a_t_u_r_e(_x = "_U_n_i_v_a_r_i_a_t_e_D_i_s_t_r_i_b_u_t_i_o_n")': mad of
          univariate distributions using corresponding 'q()'-method
          applied to 'abs(x-median(x))'.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_B_e_t_a")': for noncentrality 0 exact
          evaluation using explicit expressions.  

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_B_i_n_o_m")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_C_a_u_c_h_y")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_C_h_i_s_q")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_D_i_r_a_c")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_E_x_p")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_F_d")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_G_a_m_m_a_d")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_G_e_o_m")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_H_y_p_e_r")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_L_o_g_i_s")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_L_n_o_r_m")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_N_b_i_n_o_m")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_N_o_r_m")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_P_o_i_s")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_T_d")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_U_n_i_f")': exact evaluation using explicit
          expressions.

     '_v_a_r', '_s_i_g_n_a_t_u_r_e(_x = "_W_e_i_b_u_l_l")': exact evaluation using explicit
          expressions.

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

     Peter Ruckdeschel peter.ruckdeschel@uni-bayreuth.de

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

     'distrExIntegrate', 'm1df', 'm2df', 'Distribution-class',
      'sd', 'var', 'IQR',
      'median', 'mad',  'sd'

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

     # Variance of Exp(1) distribution
     var(Exp())

     #median(Exp())
     IQR(Exp())
     mad(Exp())

     # Variance of N(1,4)^2
     var(Norm(mean=1, sd=2), fun = function(x){x^2})
     var(Norm(mean=1, sd=2), fun = function(x){x^2}, useApply = FALSE)

     ## sd -- may equivalently be replaced by var
     sd(Pois()) ## uses explicit terms
     sd(as(Pois(),"DiscreteDistribution")) ## uses sums
     sd(as(Pois(),"UnivariateDistribution")) ## uses simulations
     sd(Norm(mean=2), fun = function(x){2*x^2}) ## uses simulations
     #
     mad(sin(exp(Norm()+2*Pois()))) ## weird

