findBreakPoints           package:snapCGH           R Documentation

~~_f_u_n_c_t_i_o_n _t_o _d_o ... ~~

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

     ~~ A concise (1-5 lines) description of what the function does. ~~

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

     findBreakPoints(states)

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

  states: ~~Describe 'states' here~~ 

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

     ~~ If necessary, more details than the description above ~~

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

     ~Describe the value returned If it is a LIST, use 

  comp1 : Description of 'comp1'

  comp2 : Description of 'comp2'

     ...

_W_a_r_n_i_n_g:

     ....

_N_o_t_e:

     ~~further notes~~ 

     ~Make other sections like Warning with \section{Warning }{....} ~

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

     ~~who you are~~

_R_e_f_e_r_e_n_c_e_s:

     ~put references to the literature/web site here ~

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

     ~~objects to See Also as 'help', ~~~

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

     ##---- Should be DIRECTLY executable !! ----
     ##-- ==>  Define data, use random,
     ##--    or do  help(data=index)  for the standard data sets.

     ## The function is currently defined as
     function (states) 
     {
         bpoints <- c(1)
         for (i in 2:length(states)) {
             if (states[i] != states[i - 1]) 
                 bpoints <- c(bpoints, i - 1, i)
         }
         bpoints <- c(bpoints, length(states))
         bpoints
       }

