API documentation

Extract from a vector of VerbalUnitAnnotations all the verbal units that belong to sentence sa.

groupsforsentence(sa, groups)

Find all tokens in tknannotations belonging to sentence s.

tokensforsentence(s, tknannotations)

Find sentence in a vector sentence annotations containing the token identified by CtsUrn u.

sentencesforurn(u, sentences, tknannotations)

Find CTS URN for range of tokens in orthotokens where orthotokens is a vector of analyzed tokens as produced by Orthography's tokenize function.

sentencerange(orthotokens)

Find CTS URN for range of tokens in tokenlist where tokenlist is a vector of annotated tokens.

sentencerange(tokenlist)

Find all tokens belonging to a given verbal unit.

tokensforgroup(group, tokens)

Find sentence that group belongs to.

sentenceforgroup(group, sentences)

Find the VerbalUnitAnnotation object for a given token.

groupfortoken(tkn, groups)

Find the SentenceAnnotation for a token t.

sentencefortoken(t, groups, sentences)

Find number of tokens from tkn to its syntactic connection.

distance(tkn, sentence, tknlist)

.

Find number of tokens from tkn to its syntactic connection.

distance(tkn, groups, sentences, tknlist)

.

Find number of tokens between tkn and its syntactic connection.

displacement(tkn, s, tknlist)

.

Find number of tokens between tkn and its syntactic connection.

displacement(tkn, groups, sentences, tknlist)

.

Find number of other groups occurring within span of grp.

displacement(grp, s, tokens)

Find number of other groups occurring within span of grp.

displacement(grp, sentences, tokens)

List other groups appearing between first and last tokens belonging to group grp.

displacedby(grp, s, tokens)

List other groups appearing between first and last tokens belonging to group grp.

displacedby(grp, sentences, tokens)

Compute the proportion of tokens within the span of grp that belonging to the group.

cohesion(grp, sentences, tokens)

Compute the proportion of tokens within the span of grp that belonging to the group.

cohesion(grp, s, tokens)

Find indexes within lexical tokens of sentence s the first and last token belonging to group grp.

span(grp, s, tokens)

Find indexes within lexical tokens of the sentence grp belongs to of the first and last tokens of group grp.

span(grp, sentences, tokens)

Find the number of tokens included in the span of grp.

spansize(grp, s, tokens)

Find the number of tokens included in the span of grp.

spansize(grp, sentences, tokens)

Find maximum depth of subordination in sentence s.

maxdepth(s, groups)

Find maximum distance between syntactically related tokens in a single sentence.

maxtokendistance(s, tknlist)

Find average distance between syntactically related tokens.

avgtokendistance(s, tknlist)

Find maximum displacement between syntactically related tokens.

maxtokendisplacement(s, tknlist)

Find average displacement between syntactically related tokens.

avgtokendisplacement(s, tknlist)

Find maximum displacement between verbal expressions.

maxgroupdisplacement(s, groups, tokens)

Find average displacement between verbal expressions.

avggroupdisplacement(s, groups, tokens)

Compose HTML string for tokens included in u.

htmltext(
    u,
    sentencelist,
    tknannotations;
    sov,
    vucolor,
    syntaxtips,
    colors,
    connectorlist
)

Compose HTML string for the annotated sentence sa using data from a vector of token annotations. Boolean flags for sov and vucolor provoke CSS additions for Subject-Object-Verb highlight, and for color coding by verbal unit.

htmltext(
    sa,
    tknannotations;
    sov,
    vucolor,
    colors,
    syntaxtips,
    connectorids
)

Compose HTML string for the annotated sentence sa indented by level of subordination. Formatting relies on data from a vector of token annotations and annotations on verbal units.

htmltext_indented(
    sa,
    groups,
    tknannotations;
    sov,
    vucolor,
    palette,
    syntaxtips,
    connectorids
)

Compose an HTML span for the verbal annotation vu.

htmlgroup(vu; palette)

Compose an HTML ordered list for verbal units belonging to sentence sa.

htmlgrouplist(sa, groups; palette)

Compose an HTML ordered list for the verbal annotations vulist.

htmlgrouplist(vulist; palette)

Compose an HTML unordered list illustrating each CSS class used in marking span elements.

sovkey()

Compose diagram in Mermaid format of the syntactic relations in sentence sa. Output formats can be text, jpg, png or svg.

mermaiddiagram(sa, tknannotations; format)

Find a starting and ending index withint tknannotations for connecting words annotated for sentence s.

connectorindexes(s, tknannotations)

Find index in tknannotations of the first token belonging to sentence s.

originindex(s, tknannotations)

Find index in a vector sentence annotations of the sentence containing the token identified by CtsUrn leafnode.

sentenceindexfornode(leafnode, sentences, tknannotations)

Find list of distinct syntactic types in sentence s.

syntactictypes(s, groups)

Find syntactic depth of token tkn.

depthfortoken(tkn, groups)

Find all tokens at level of subordination <= depth.

filterbylevel(depth, groups, tokens)

Map a TokenAnnotation to a CitablePassage cited at the token level.

passagefromtoken(tkn)

Compose a tooltips attribute documenting the syntactic relation of token t.

tipsfortoken(t, tkns, isconnector)

Compose string for a token, wrapping lexical tokens in an HTML span. Based on lexical type and context indicated by inprefix flag, prefixes the resulting string with a leading space or not.

htmltoken(
    t,
    tokens,
    inprefix,
    connectingword,
    add_sov,
    add_color;
    colors,
    syntaxtips
)

Compose an HTML class attribute for a lexical token.

classesfortoken(t, isconnector; syntaxtips, sov)

Select a color to use for item idx by mod'ing a list of colors. Add one to avoid zero indexes.

groupcolorforint(idx; colors)

Choose a color from a list of colors based on group number component of the token's verbal unit identifier.

groupcolorfortoken(tkn; colors)

Choose a color from a list of colors based on the convention of ending the identifier for a VerbalUnitAnnotation with a number.

groupcolor(vu; colors)

Choose a color from a list of colors based on the convention of ending the identifier for a VerbalUnitAnnotation with a number.

groupcolor(groupid; colors)