readRep               package:PBSadmb               R Documentation

_R_e_a_d _a_n _A_D_M_B _R_e_p_o_r_t _i_n_t_o _R _M_e_m_o_r_y

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

     Import ADMB-generated report files into R's memory using the names
     of the  report files to name the R-objects.

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

     readRep(prefix, suffix=c(".cor",".rep",".std",".mc.dat"), global=FALSE)

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

  prefix: string name prefix of the ADMB project (e.g., '"vonb"').

  suffix: string scalar/vector specifying one or more suffixes.

  global: logical: if 'TRUE', save the imported reports as objects to 
          global environment using the same names as the report files.

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

     If the report object is one of 'c(".cor", ".std", ".mc.dat")', the
     report object is a data frame, otherwise it is a string vector.
     Multiple  report objects are returned as a list of objects. A
     single report object is  returned as the object itself.

     This function attempts to detect the file format from a number of
     possibilities. For example, if the file has the special format
     recognized by PBSmodelling, then the function returns a list with
     named components. The example 'vonb' included with this package
     shows how to write the template to get consistent variable names
     between ADMB and R. See the User's Guide for complete details.

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

     Invisibly returns the list of report objects. If only one report
     is  imported, a single report object is returned.

_N_o_t_e:

     A wrapper function that can be called from a GUI exists as
     '.win.readRep'.

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

     Rowan Haigh, Pacific Biological Station, Nanaimo BC, Canada

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

     'editADfile', '.win.viewRep'

