cf                 package:financial                 R Documentation

_C_a_s_h _F_l_o_w _m_o_d_e_l

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

     Calculates a Cash Flow model from a vector of flows.

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

     cf(x, i = NULL, safe = NULL, rein = safe)

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

       x: a vector of cash flows. 

       i: a vector of periodic rates used in calculating NPV, NFV and
          NUS table. 

    safe: a vector of safe periodic rates using in calculating MIRR. 

    rein: a vector of reinvestment periodic rates using in calculating
          MIRR. 

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

     The negative values are money paid out, the positive values are
     money received in.

     IRR (Internal rate of return) is calculated by solving polynomial,
     using 'polyroot' function. If IRR equation have several real
     solutions, all are found.

     NPV extremes are found in the same method, after obtaining
     first-order derivative of IRR equation.

     MIRR table and NPV table are created only if i, safe and rein are
     given (are not null).

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

     An object of class "cf", being a list of the following compounds:

      cf: a vector of cash flows.

    mirr: a matrix containing for each safe and reinvestment rate pair
          - modified internal rate of return values. If not calculated,
          has NULL value.

     tab: a matrix containing for each periodic rate (i) - NPV, NFV and
          NUS value. If not calculated, set to NULL.

     irr: a vector of IRR values - real rates giving NPV equal to zero.
          The number of values are dependent of sign changes in cash
          flow series (one or more real roots of polynomial).

     ext: a vector of rate values giving extremes in NPV - maxima or
          minima. May have no values, if they are no sign changes in
          cash flows.

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

     Lukasz Komsta

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

     'summary.cf'

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

     y = cf(c(-2500,6250,-3800),1:10,2:11,4:13)
     y
     summary(y)
     plot(y)
     plot(y,type="n")

