tm (version 0.3-1)

readPlain: Read In a Text Document

Description

Returns a function which reads in a text document without knowledge about its internal structure and possible available metadata.

Usage

readPlain(...)

Arguments

...

arguments for the generator function.

Value

• A function with the signature elem, language, load, id:
• elem
  A list with the two named elements content and uri. The first element must hold the document corpus to be read in, the second element must hold a call to the document corpus. The call is evaluated upon a request for load on demand.
• language
  A character giving the text's language.
• load
  A logical value indicating whether the document corpus should be immediately loaded into memory.
• id
  A character representing a unique identification string for the returned text document.
• The function returns a PlainTextDocument representing content.

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 via lexical scoping. This is especially useful for reader functions for complex data structures which need a lot of configuration options.