RWordXMLDoc-class: Representation of main XML document within a .docx file

RWordXMLDoc-classR Documentation

Representation of main XML document within a .docx file

Description

This class represents a parsed XML document that originates from reading the primary document within a Word .docx file. This is a regular XMLInternalDocument from the XML package, but has the additional class information so that we can operate on it via methods that understand the nature of the content, i.e. Word structure.

Objects from the Class

A virtual Class: No objects may be created from it.

Slots

.S3Class:

Object of class "character" this an opaque data type inherited from the XML package.

Extends

Class "XMLInternalDocument", directly. Class "XMLAbstractDocument", by class "XMLInternalDocument", distance 2. Class "oldClass", by class "XMLInternalDocument", distance 3.

Methods

coerce

signature(from = "RWordXMLDoc", to = "WordArchive"): ...

Author(s)

Duncan Temple Lang

References

~put references to the literature/web site here ~

See Also

WordArchive-class

Examples

f = system.file("SampleDocs", "sampleLists.docx", package = "RWordXML")
doc = wordDoc(f)
x = doc[[getDocument(doc)]]
y = doc[["word/document.xml"]]  # note that this doesn't have the special class.
class(x)
class(y)
class(doc[["/word/document.xml"]])  # this one does because of the /.
                                    #  We may get around to changing this!

duncantl/RWordXML documentation built on Nov. 23, 2023, 4:23 p.m.