get                   package:base                   R Documentation

_R_e_t_u_r_n _a _V_a_r_i_a_b_l_e'_s _V_a_l_u_e

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

     Search for an R object with a given name and return it if found.

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

     get(x, pos=-1, envir=as.environment(pos), mode="any", inherits=TRUE)

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

       x: a variable name (given as a character string).

     pos: where to look for the object (see the details section); if
          omitted, the function will search, as if the name of the
          object appeared in unquoted in an expression. 

   envir: an alternative way to specify an environment to look in; see
          the details section.

    mode: the mode of object sought.

inherits: should the enclosing frames of the environment be inspected?

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

     The 'pos' argument can specify the  environment in which to look
     for the object in any of several ways: as an integer (the position
     in the 'search' list); as the character string name of an element
     in the search list; or as an 'environment' (including using
     'sys.frame' to access the currently active function calls). The
     'envir' argument is an alternative way to specify an environment,
     but is primarily there for back compatibility.

     The 'mode' includes collections such as '"numeric"' and
     '"function"': any member of the collection will suffice.

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

     This function searches the specified environment for a bound
     variable whose name is given by the character string 'x'.  If the
     variable's value is not of the correct 'mode', it is ignored.

     If 'inherits' is 'FALSE', only the first frame of the specified
     environment is inspected.  If 'inherits' is 'TRUE', the search is
     continued up through the parent frames until a bound value of the
     right mode is found.

     Using a 'NULL' environment is equivalent to using the current
     environment.

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

     Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988) _The New S
     Language_. Wadsworth & Brooks/Cole.

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

     'exists'.

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

     get("%o%")

