tell               package:sensitivity               R Documentation

_C_o_m_p_u_t_a_t_i_o_n _O_f _S_e_n_s_i_t_i_v_i_t_y _I_n_d_i_c_e_s _W_h_e_n _T_h_e _M_o_d_e_l _I_s _E_x_t_e_r_n_a_l

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

     'tell' is used to tell a sensitivity analysis object the results
     of the simulations. It is used when the model is not given when
     parametring the sensitivity analysis (whith the model=NULL
     argument). For example, it is the case when the model is external
     to R.

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

     tell(sa, y = NULL)

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

      sa: the sensitivity analysis object

       y: the response

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

     'sa' is an object returned by a sensitivity analysis function,
     such as 'srcpcc', 'morris', 'sobol',...

     'y' should be a 'numeric' vector.

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

     'tell' doesn't return anything. It does the sensitivity analysis,
     and stores all the results in the variable 'sa'.

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

     # Example of the FAST method
     # (one should note the call with model = NULL)

     sa <- fast(model = NULL, factors = 8, n = 1000)

     # at this stage, only the design of experiment (sa$x) was generated
     # the response is computed "manually":

     y <- sobol.fun(sa$x) # at this place could be a
                          # call to an external code

     # then, the sensitivity analysis:

     tell(sa, y)
     print(sa)

     # Remark : because the model is a simple R function,
     # this example is equivalent to :
     ## Not run: sa <- fast(model = sobol.fun, factors = 8, n = 1000)

