describe                package:rsbml                R Documentation

_D_e_s_c_r_i_b_i_n_g _o_b_j_e_c_t_s

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

     Each class in the SBML DOM extends the 'Describable' class and
     thus has a 'describe' method, which describes an object with a
     short string. This is used by the 'show' method to output terse
     textual representations of the DOM.

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

       describe(object, ...)

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

  object: The object to be described.

     ...: Additional arguments for methods.

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

     A short textual (string) representation of 'object'.

_D_e_s_c_r_i_b_a_b_l_e _o_b_j_e_c_t_s:

     An object that extends 'Describable' has a method for the
     'describe' generic, and by default 'Describable' objects are
     'show'n by printing the output of 'describe'. Note that
     'Describable' is a virtual tag class, no objects may be created
     from it.

_D_e_s_c_r_i_b_a_b_l_e _m_e_t_h_o_d_s:


     _s_h_o_w 'signature(object = "Describable")': outputs the return value
          of 'describe'. 

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

     Michael Lawrence

