readXML: Read In an XML Document
In tm: Text Mining Package
readXML R Documentation
Read In an XML Document
Description
Return a function which reads in an XML document. The structure of
the XML document is described with a specification.
Usage
readXML(spec, doc)
Arguments
spec
A named list of lists each containing two components. The
constructed reader will map each list entry to the content or metadatum of
the text document as specified by the named list entry. Valid names include
content to access the document's content, and character strings which
are mapped to metadata entries.
Each list entry must consist of two components: the first must be a string
describing the type of the second argument, and the second is the
specification entry. Valid combinations are:
type = "node", spec = "XPathExpression"The XPath (1.0)
expression spec extracts information from an XML node.
type = "function", spec = function(doc) ...The function
spec is called, passing over the XML document (as
delivered by read_xml from package xml2) as
first argument.
type = "unevaluated", spec = "String"The character vector
spec is returned without modification.
doc
An (empty) document of some subclass of TextDocument.
Details
Formally this function is a function generator, i.e., it returns a
function (which reads in a text document) with a well-defined
signature, but can access passed over arguments (e.g., the specification)
via lexical scoping.
Value
A function with the following formals:
elema named list with the component content which
must hold the document to be read in.
languagea string giving the language.
ida character giving a unique identifier for the created
text document.
The function returns doc augmented by the parsed information
as described by spec out of the XML file in
elem$content. The arguments language and id are used as
fallback: language if no corresponding metadata entry is found in
elem$content, and id if no corresponding metadata entry is found
in elem$content and if elem$uri is null.
See Also
Reader for basic information on the reader infrastructure
employed by package tm.
Vignette 'Extensions: How to Handle Custom File Formats', and
XMLSource.
tm documentation built on Sept. 11, 2024, 6:47 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| readXML | R Documentation |
Read In an XML Document
Description
Return a function which reads in an XML document. The structure of the XML document is described with a specification.
Usage
readXML(spec, doc)
Arguments
spec |
A named list of lists each containing two components. The
constructed reader will map each list entry to the content or metadatum of
the text document as specified by the named list entry. Valid names include
Each list entry must consist of two components: the first must be a string describing the type of the second argument, and the second is the specification entry. Valid combinations are:
|
doc |
An (empty) document of some subclass of |
Details
Formally this function is a function generator, i.e., it returns a function (which reads in a text document) with a well-defined signature, but can access passed over arguments (e.g., the specification) via lexical scoping.
Value
A function with the following formals:
elema named list with the component
contentwhich must hold the document to be read in.languagea string giving the language.
ida character giving a unique identifier for the created text document.
The function returns doc augmented by the parsed information
as described by spec out of the XML file in
elem$content. The arguments language and id are used as
fallback: language if no corresponding metadata entry is found in
elem$content, and id if no corresponding metadata entry is found
in elem$content and if elem$uri is null.
See Also
Reader for basic information on the reader infrastructure
employed by package tm.
Vignette 'Extensions: How to Handle Custom File Formats', and
XMLSource.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.