Core classes

Core classes of FinTxtUtils. They all inherit from the ‘Fingerprint’ class, but are organized along the lines of Cortical’s taxonomy.

Filter()

Filter class

Expression()

Expression-class

Term()

Term class

Document()

Document class

Fingerprint-class

Fingerprint class

Ancillary classes

Useful classes that are core R implementations

Collection()

Collection class

Intensity()

Constructor for Intensity class

Core functions

Core functionality to fingerprint terms, documents, expressions or to create filters.

do_fingerprint_document()

Fingerprint one or multiple texts

do_fingerprint_term()

Fingerprint a term

do_fingerprint_expression()

Create an expression

do_create_filter()

Create a category filter

Class methods

Methods that belong to classes

do_compare()

Similarity/Distance between fingerprints

get_context()

Get contexts for a fingerprint

get_keywords()

Retrieve a list of keywords for a text

as.collection()

Turn a list of Expressions, Terms or Documents into a Collection

show(<Fingerprint>)

Print method for Fingerprint class

plot(<Fingerprint>)

Plot method for Fingerprint class

show(<Collection>)

Show method for Collection class

plot(<Collection>)

Plot method for Collection class

as.list(<Collection>)

Turn a Collection into a list

as.matrix(<Collection>)

Turn a collection of fingerprints into a sparse binary matrix

length(<Collection>)

Length of a Collection object

do_slice_document()

Slice a text

do_tokenize()

Tokenize a text

get_similar_terms()

Get similar terms for a fingerprint

do_search_collection()

Search a collection for one or multiple unique ids

Getters

Simple functions that retrieve slots from S4 class objects

uuid() type() fingerprint() text() sfexpression() term() df() score() pos_types() name() positive() negative() entries()

Get slots from sfutils classes

Data sets

Datasets for user to play around with.

fps_train fps_test

Fingerprints and labels for 690 documents (train set) and 189 documents (test set)

company_descriptions

Small sample of business descriptions of six companies

SAP500

Business descriptions for S&P500 companies