hints                 package:hints                 R Documentation

_L_i_s_t _f_u_n_c_t_i_o_n_s _t_h_a_t _a_c_t _o_n _a_n _o_b_j_e_c_t

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

     Once you create an object of a particular type, remembering the
     functions that exist to act on that object can be difficult.  This
     function provides a simple list of these functions.

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

     hints(x, class = base::class(x))

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

       x: Any R object.  Either 'x' or 'class' must be supplied. 

   class: A class of objects; the default is the class of 'x'. 

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

     This function returns an object with S3 class
     'c("hints","matrix")' giving a list of functions that accept
     objects of the specified class, the package that includes the
     function, and  a short description of what that function does. 
     The descriptions are taken from the title entry of the
     documentation for the function.

     The 'print' function prints the output in a sensible way.  The
     object is compatible with the 'xtable' package to get LaTeX
     output, and all the arguments to 'xtable' can be used.

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

     This function was written by Hadley Wickham, h.wickham@gmail.com,
     based on a suggestion by Sanford Weisberg at the useR! 2006
     conference in Vienna.  Minor changes were made by Sanford
     Weisberg, sandy@stat.umn.edu

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

     'print.hints'

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

     m <- lm(BOD)
     hints(m)
     # print hints as a "LaTeX-style tagged description"
     print(hints(class="glm"),style="list")
     ## Not run: 
     library(xtable)
     xtable(hints(m))
     ## End(Not run)

