ll                   package:R.oo                   R Documentation

_G_e_n_e_r_a_t_e_s _a _l_i_s_t _o_f _i_n_f_o_r_m_a_t_i_v_e _p_r_o_p_e_r_t_i_e_s _o_f _a_l_l _m_e_m_b_e_r_s _o_f _a_n _e_n_v_i_r_o_n_m_e_n_t

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

     Generates a list of informative properties of all members of an
     environment.

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

     ## Default S3 method:
     ll(pattern=".*", ..., private=FALSE, properties=getOption("R.oo::ll/properties"), sortBy=NULL, envir=parent.frame())

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

 pattern: Regular expression pattern specifying which members to
          return. If '".*"', all names are matched.

     ...: A named 'vector' of format 'functionName=value', where
          'functionName()' will be called on each member found. If the
          result matches the 'value', the member is returned, otherwise
          not.

 private: If 'TRUE', also private members, i.e. members with a name
          starting with a '.' (period), will be listed, otherwise not.

properties: Names of properties to be returned. There must exist a
          'function' with the same name, because it will be called.
          This way one can extract any type of property by defining new
          methods.

  sortBy: Name or index of column (property) to be sorted by. If
          'NULL', the objects are listed in the order they are found.

   envir: An 'environment', a search path index or a name of a package
          to be scanned.

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

     Returns a 'data.frame' containing information about all the
     members.

_D_e_f_a_u_l_t _p_r_o_p_e_r_t_i_e_s _r_e_t_u_r_n_e_d:

     It is possible to set the default value of argument 'properties'
     by setting option '"R.oo::ll/properties"', e.g.
     'options("R.oo::ll/properties"=c("data.class", "dimension"))'. If
     this option is not set when the package is loaded, it is set to
     'c("data.class", "dimension", "objectSize")'.

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

     Henrik Bengtsson (<URL: http://www.braju.com/R/>)

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

     'll.Object'().

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

       ## Not run: 
        To list all objects in .GlobalEnv:
        > ll()
                          member data.class dimension objectSize
        1                *tmp*     Person         1         428
        2  as.character.Person   function      NULL        1208
        3              country  character         1          44
        4        equals.Person   function      NULL        2324
        5             filename  character         1          84
        6               getAge   function      NULL         372
        7        getAge.Person   function      NULL         612
        8       getName.Person   function      NULL         628
        9      hashCode.Person   function      NULL        1196
        10        last.warning       list         1         192
        11                 obj     Person         1         428
        12              Person      Class      NULL        2292
        13              setAge   function      NULL         372
        14       setAge.Person   function      NULL        2088
        15             setName   function      NULL         372
        16      setName.Person   function      NULL         760
        17   staticCode.Person   function      NULL        2372

        To list all functions in the methods package:
        ll(mode="function", envir="methods")

        To list all numeric and character object in the base package:
        ll(mode=c("numeric", "character"), envir="base")

        To list all objects in the base package greater than 40kb:
        subset(ll(envir="base"), objectSize > 40000)
       ## End(Not run)

