getRelationships: Process relationships between the different elements of an...

In duncantl/ROOXML: Simple tools for Open Office XML documents

Process relationships between the different elements of an Office Open document

Description

Office Open documents are made up of separate files that are combined together in various ways. They logic for how the different contents are combined is mostly controlled by the "relationships" which are a series of maps of part to document. These functions provide facilities for working with these relationships in R in order to make sense of an Office Open document. getDocument gets the name of the component/file in the archive that corresponds to the top-level document, e.g. the word processing document or the workbook.

getRelationships returns a data frame of relationship id, target and type triples.

resolveRelationships identifies the components in the document archive corresponding to a particular identifier.

getPart looks up the name of the entry in the archive corresponding to a conceptual part, e.g. document. One can index with the full name of the part or the name of the usual file at which that part is located. The parts come from the PartName entries in the "[Content_Types].xml" component of the archive, i.e. via a call to contentTypes.

getPart does partial matching anywhere in the string.

getPart matches by partial name on the PartName attribute first, then by regular expression on the attribute PartName. If the part is As-Is, then we look for that literal string rather than treating the string as a possible regular expression.

Usage

getDocument(doc, ...)
resolveRelationships(ids, doc, relTable = getRelationships(doc), relativeTo = character())
getPart(doc, part, default = NA, stripSlash = TRUE, parts = computeParts(doc))
getRelationships(doc, rels = doc[["_rels/.rels"]])

Arguments

doc	the Office Open document whose properties are being queried. This is a generic OOXMLArchive object but typically created via a constructor function from another package which provide interfaces for specific types of Office Open documents..
rels	the XML document specifying the relationships between components within the OO document.
parts	the collection of available parts from the document. If one is making repeated queries of the document, it can be convenient to compute the table of parts just once via the (non-exported) computeParts function.
...	additional parameters for methods
part	a string identifying the part by file name or content type. Use I to have the function treat it the part name as a fixed literal string rather than regular expression.
default	the value to return if the specified part is not found/matched
stripSlash	logical value indicating whether to remove the initial / in the part name, e.g. "/word/document.xml" would become "word/document.xml"
ids	the identifiers that we want to resolve with respect to the relationships table in the document
relTable	the relationship table from the OO document
relativeTo	the directory to paste in front of the result

Value

getDocument returns a character string (vector of length 1) giving the name of the component in the archive of the main document.

resolveRelationships returns a character vector.

getPart returns a character vector

getRelationships returns a data frame with as many rows as there are relationships within the top-level of the document and with 3 columns/variables. These are the relationship identifier (id), the target component in the archive (target) and the type of the relationship (type).

Examples

  
  d = createOODoc(system.file("SampleDocs", "WordEg.docx", package = "ROOXML"))
  getRelationships(d)
  resolveRelationships("rId1", d)
        
  d = createOODoc(system.file("SampleDocs", "WordEg.docx", package = "ROOXML"))
  getPart(d, "numbering.xml")  # by file name
  getPart(d, I("comments+xml"))  # by content type
  

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