matrix2DocBook: Create an XML representation of an R matrix for specific...

matrix2DocBookR Documentation

Create an XML representation of an R matrix for specific target format

Description

These functions convert an R matrix into an XML representation which can be inserted into an XML document and rendered as part of a readable document for a human. These take care of rendering the R object as a table or as verbatim content.

These are typically invoked as part of the dynamic processing of a document when returning an R matrix object as the value of some XSL computation. However, they are also available for creating content directly within R.

Usage

matrix2DocBook(obj, digits = 3, border = FALSE, frame = FALSE, ..., doc = NULL)

Arguments

obj

the R matrix object

digits

integer, the number of digits to display of each individual value

border

logical, whether to include a border around the "table"

frame

logical whether to display a frame around the "table"

...

additional parameters for the individual methods

doc

the document in which the XML content will be inserted. This can be a node or a top-level document. This can be useful when creating the nodes, e.g. to provide XML namespace definitions, etc.

Value

An XML node.

Author(s)

Duncan Temple Lang


duncantl/XDynDocs documentation built on Jan. 4, 2024, 5:20 p.m.