API documentation

Published

June 14, 2024

Types

AbbreviatedUrn

Short form of a Cite2Urn containing only collection and object ID.

Stem

Supertype of all concrete Stem structures.

Rule

Supertype of all concrete Rule structures.

Analysis

Citable analysis of a string value.

An Analysis has five members: a token string value, and four abbreviated URNs, one each for the lexeme, form, rule and stem.

StemUrn

Abbreviated URN for a morphological stem.

RuleUrn

Abbreviated URN for rule.

LexemeUrn

Abbreviated URN for a lexeme.

FormUrn

Abbreviated URN for a morphological form.

AnalyzedToken

Morphological analyses for a token identified by CTS URN.

Parsing

parsetoken

Parse a single token using parser.

parsetoken(s, parser)

parsepassage

Parse a CitablePassage with text for a single token with a CitableParser.

parsepassage(cn, p; data)

Returns a single AnalyzedToken.

Parse a CitablePassage with text for a single token with a CitableParser.

parsepassage(ct, p; data)

Returns a single AnalyzedToken.

parsecorpus

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

Working with vectors of AnalyzedTokens

lexemes

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

stringsforlexeme

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

lexemedictionary

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

Working with AbbreviatedUrns

abbreviate

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

expand

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

fstsafe

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

Working with Stems and Rules

CitableParserBuilder.lexeme

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

CitableParserBuilder.id

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

CitableParserBuilder.inflectiontype

Use a CitableParser to parse a CitableTextCorpus with each citable node containing containg a single token of type LexicalToken.

parsecorpus(c, p; data, countinterval)

Returns anAnalyzedTokens object.

Serialization

tofile

Write dataframe parser to a delimited file.

tofile(dfp, outfile; delimiter)

Write entries to file.

tofile(p, f; addheader)

delimited

Serialize an Analysis to delimited text. Abbreviated URNs are expanded to full CITE2 URNs using registry as the expansion dictionary.

delimited(a; delim, registry)

Serialize a Vector of Analysis objects as delimited text.

delimited(v; delim, registry)

Serialize a single AnalyzedToken as one or more lines of delimited text.

delimited(at; delim, registry)

Serialize a Vector of AnalyzedTokens as delimited text.

delimited(v; delim, registry)

Serialize an AnalyzedTokens object as delimited text (required for Citable interface).

delimited(atcollection; delim, registry)

Uses abbreviated URNs. These can be expanded to full CITE2 URNs when read back with a URN registry, or the delimited function can be used with a URN registry to write full CITE2 URNs.

cex

No documentation found.

Binding cex does not exist.