saveXML                 package:XML                 R Documentation

_O_u_t_p_u_t _i_n_t_e_r_n_a_l _X_M_L _T_r_e_e

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

     Methods for writing the representation of an XML tree to a string
     or file. Originally this was intended to be used only for DOMs
     (Document Object Models) stored in internal memory created via
     'xmlTree', but methods for 'XMLNode' and 'XMLOutputStream' objects
     allow it to be generic for different representations of the XML
     tree.

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

     saveXML(doc, file=NULL, compression=0, indent=TRUE, prefix = '<?xml version="1.0"?>\n')
     saveXML.XMLInternalDocument(doc, file=NULL, compression=0, indent=TRUE, prefix = '<?xml version="1.0"?>\n')
     saveXML.XMLInternalDOM(doc, file=NULL, compression=0, indent=TRUE, prefix = '<?xml version="1.0"?>\n')
     saveXML.XMLNode(doc, file=NULL, compression=0, indent=TRUE, prefix = '<?xml version="1.0"?>\n')
     saveXML.XMLOutputStream(doc, file=NULL, compression=0, indent=TRUE, prefix = '<?xml version="1.0"?>\n')

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

     doc: the document object representing the XML document.

    file: the name of the file to which the contents of the XML nodes
          will be serialized.

compression: an integer value between 0 and 9 indicating the level of
          compression to use when saving the file. Higher values
          indicate increased compression and hence smaller files at the
          expense of computational time to do the compression and
          decompression.

  indent: a logical value indicating whether to indent the nested nodes
          when serializing to the stream.

  prefix: a string that is written to the stream/connection before the
          XML is output. If this is NULL, it is ignored. This allows us
          to put the XML introduction/preamble at the beginning of the
          document while allowing it to be omitted when we are
          outputting multiple "documents" within a single stream.

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

     One can create an internal XML tree (or DOM) using 'newXMLDoc' and
     'newXMLNode'. 'saveXML' allows one to generate a textual
     representation of that DOM in human-readable and reusable XML
     format. 'saveXML' is a generic function that allows one to call
     the rendering operation with either the top-level node of the DOM
     or of the document object (of class 'XMLInternalDocument' that is
     used to  accumulate the nodes and with which the developer  adds
     nodes.

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

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

     Duncan Temple Lang

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

     <URL: http://www.w3.org/XML>, <URL: http://www.omegahat.org/RSXML>

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

     'newXMLDoc' 'newXMLNode' 'xmlOutputBuffer' 'xmlOutputDOM'

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

     con <- xmlOutputDOM()
     con$addTag("author", "Duncan Temple Lang")
     con$addTag("address",  close=FALSE)
     con$addTag("office", "2C-259")
     con$addTag("street", "Mountain Avenue.")
     con$addTag("phone", close=FALSE)
     con$addTag("area", "908", attrs=c(state="NJ"))
     con$addTag("number", "582-3217")
     con$closeTag() # phone
     con$closeTag() # address

     saveXML(con$value(), file="con.xml")

