rtext (version 0.1.22)

rtext: R6 class - linking text and data

Description

R6 class - linking text and data

R6 class - linking text and data

Value

Object of R6Class

Format

An R6Class generator object.

The rtext class family

Rtext consists of an set of R6 classes that are conencted by inheritance. Each class handles a different set of functionalities that are - despite needing the data structure provided by rtext_base - independent.

R6_rtext_extended

A class that has nothing to do per se with rtext but merely adds some basic features to the base R6 class (debugging, hashing, getting fields and handling warnings and messages as well as listing content)

rtext_base

[inherits from R6_rtext_extended] The foundation of the rtext class. This class allows to load and store text, its meta data, as well as data about the text in a character by character level.

rtext_loadsave

[inherits from rtext_base] Adds load and save methods for loading and saving rtext objects (text and data) into/from Rdata files.

rtext_export

[inherits from rtext_loadsave] Adds methods to import and export from and to SQLite databases - like load and save but for SQLite.

rtext_tokenize

[inherits from rtext_export] Adds methods to aggregate character level data onto token level. (the text itself can be tokenized via S3 methods from the stringb package - e.g. text_tokenize_words())

rtext

[inherits from rtext_tokenize] Adds no new features at all but is just a handy label sitting on top of all the functionality provided by the inheritance chain.

Super classes

rtext::R6_rtext_extended -> rtext::rtext_base -> rtext::rtext_loadsave -> rtext::rtext_export -> rtext::rtext_tokenize -> rtext

Methods

Public methods

• rtext$clone()

• rtext::R6_rtext_extended$debug()

• rtext::R6_rtext_extended$get()

• rtext::R6_rtext_extended$ls()

• rtext::R6_rtext_extended$message()

• rtext::R6_rtext_extended$warning()

• rtext::rtext_base$char_add()

• rtext::rtext_base$char_data_get()

• rtext::rtext_base$char_data_set()

• rtext::rtext_base$char_data_set_regex()

• rtext::rtext_base$char_delete()

• rtext::rtext_base$char_get()

• rtext::rtext_base$char_length()

• rtext::rtext_base$char_replace()

• rtext::rtext_base$hash_get()

• rtext::rtext_base$info()

• rtext::rtext_base$initialize()

• rtext::rtext_base$text_get()

• rtext::rtext_base$text_get_lines()

• rtext::rtext_base$text_show()

• rtext::rtext_loadsave$load()

• rtext::rtext_loadsave$save()

• rtext::rtext_export$export_csv()

• rtext::rtext_export$export_sqlite()

• rtext::rtext_export$import_csv()

• rtext::rtext_export$import_sqlite()

• rtext::rtext_tokenize$tokenize_data_lines()

• rtext::rtext_tokenize$tokenize_data_regex()

• rtext::rtext_tokenize$tokenize_data_sequences()

• rtext::rtext_tokenize$tokenize_data_words()

Method clone()

The objects of this class are cloneable with this method.

Usage

rtext$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# NOT RUN {
# initialize (with text or file)
quote_text <-
"Outside of a dog, a book is man's best friend. Inside of a dog it's too dark to read."
quote <- rtext$new(text = quote_text)

# add some data
quote$char_data_set("first", 1, TRUE)
quote$char_data_set("last", quote$char_length(), TRUE)

# get the data
quote$char_data_get()

# transform text
quote$char_add("[this is an insertion] \n", 47)

# get the data again (see, the data moved along with the text)
quote$text_get()
quote$char_data_get()

# do some convenience coding (via regular expressions)
quote$char_data_set_regex("dog_friend", "dog", "dog")
quote$char_data_set_regex("dog_friend", "friend", "friend")
quote$char_data_get()

# aggregate data by regex pattern
quote$tokenize_data_regex(split="(dog)|(friend)", non_token = TRUE, join = "full")

# aggregate data by words
quote$tokenize_data_words(non_token = TRUE, join="full")

# aggregate data by lines
quote$tokenize_data_lines()

# plotting and data highlighting
plot(quote, "dog_friend")

# adding further data to the plot
plot(quote, "dog_friend")
plot(quote, "first", col="steelblue", add=TRUE)
plot(quote, "last", col="steelblue", add=TRUE)

# }