PlainTextDocument

From tm v0.6-2 by Ingo Feinerer

Plain Text Documents

Create plain text documents.

Usage

PlainTextDocument(x = character(0), author = character(0), datetimestamp = as.POSIXlt(Sys.time(), tz = "GMT"), description = character(0), heading = character(0), id = character(0), language = character(0), origin = character(0), ..., meta = NULL, class = NULL)

Arguments

x: A character giving the plain text content.
author: a character or an object of class person giving the author names.
datetimestamp: an object of class POSIXt or a character string giving the creation date/time information. If a character string, exactly one of the ISO 8601 formats defined by http://www.w3.org/TR/NOTE-datetime should be used. See parse_ISO_8601_datetime in package NLP for processing such date/time information.
description: a character giving a description.
heading: a character giving the title or a short heading.
id: a character giving a unique identifier.
language: a character giving the language (preferably as IETF language tags, see language in package NLP).
origin: a character giving information on the source and origin.
...: user-defined document metadata tag-value pairs.
meta: a named list or NULL (default) giving all metadata. If set all other metadata arguments are ignored.
class: a character vector or NULL (default) giving additional classes to be used for the created plain text document.

Value

An object inheriting from class, PlainTextDocument and TextDocument.

Examples

(ptd <- PlainTextDocument("A simple plain text document",
                          heading = "Plain text document",
                          id = basename(tempfile()),
                          language = "en"))
meta(ptd)

Documentation reproduced from package tm, version 0.6-2, License: GPL-3

Community examples

Looks like there are no examples yet.