gsi.margin           package:compositions           R Documentation

_I_n_t_e_r_n_a_l _f_u_n_c_t_i_o_n: _C_o_m_p_u_t_e _a _d_e_s_i_r_e_d _c_o_m_p_o_s_i_t_i_o_n_a_l _m_a_r_g_i_n

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

     This generic function should select the selected type of margin
     based on the class of the dataset and the specified margin type.

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

     gsi.margin(X,...)
     gsi.margin.acomp(X,what,...,margin="acomp")
     gsi.margin.rcomp(X,what,...,margin="rcomp")
     gsi.margin.aplus(X,what,...)
     gsi.margin.rplus(X,what,...)

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

       X: The dataset to take the margin from.

    what: The indices xor column names to be kept.

  margin: The type of marginalisation to be used. Possible values are:
          '"sub"', '"rcomp"', '"acomp"' and an index xor a name of a
          variable in the dataset.

     ...: other arguments 

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

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

     Some marginal dataset or vector still containing the variables
     given by 'what' and optionally one additional part named '"+"',
     '"*"' or margin.

_N_o_t_e:

     Do not use gsi.* functions directly since they are internal
     functions of the package

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

     'gsi'

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

     data(SimulatedAmounts)
     plot(gsi.margin(acomp(sa.lognormals5),c("Cd","Cu")))

