Function reference • rezonateR

Importing, exporting, saving and loading

Functions for importing .rez files, saving and loading rezonateR files, and exporting to other formats.

importRez(): Import a Rez file

rez_pangloss(): Read Pangloss file

rez_write_csv() rez_read_csv(): Read and write rezrDFs as CSV files

updateFromDF(): Update a rezrDF using data from another data frame

getLowerFieldList() getTrackTokens(): Get a list of values from a lower-level table.

rez_save() rez_load(): Save and load rezrObj and rezrDF objects.

Basics of rezrObjs and rezrDFs

combineLayers() combineChunks() combineTokenChunk(): Combine different layers of an entity, and similar entities

deps() `deps<-`(): Extract/set an attribute of a updateFunction.

getLayerAddresses() getTokenChunkAddresses(): Get all the addresses of a rezrDF with multiple layers

getRezrDFAttr() fieldaccess() updateFunct() inNodeMap() setRezrDFAttr() `updateFunct<-`() `fieldaccess<-`() `inNodeMap<-`(): Extract/set an attribute of a rezrDF.

reload() reloadLocal() reloadForeign(): Functions for reloading auto and foreign fields.

findContainingChunk() addContainingChunk(): Find chunks containing other chunks

undupeSingle() undupeLayers(): De-duplicate a rezrObj entity.

mergeChunksWithIDs(): Relate table rows to tree entries covering the same tokens.

Time, sequence and stacks

addIsWordField(): Add a field on whether something is a word or not.

addUnitSeq(): Add unit sequence information to different levels of rezrObj.

getSeqBounds(): Get the max and min of a certain value from a lower object table to a higher object table.

isInitial() isFinal(): Functions for getting information on whether something is located at the beginning or end of a larger structure.

getTurnFromAnnos(): Get turn IDs from turn position annotations (deprecated)

getBiluoFromOrder(): Get BILUO (begin-intermediate-last-unique-outside) values from a sequence value.

getOrderFromSeq() getSeqFromOrder(): Get sequence number (position) within a larger structure (turn, prosodic sentence, etc.) from the ID of that structure, or the other way around

stackToUnit() stackToToken(): Add stack sequence information to tokens and units

getGantt(): Get Gantt charts from rezrObj.

EasyEdit

Functions for editing rezonateR objects.

addField() changeField(): Shortcut functions for functions beginning with addField and changeField

addFieldLocal() changeFieldLocal(): Easily add a field to / change a field in a rezrDF using only information from that rezrDF

addFieldForeign() changeFieldForeign(): Easily add a field to / change a field in a rezrDF using information from another rezrDF. Has two variants that may be applied to rezrDFs or rezrObjs,

addRow(): Add rows to a certain data.frame

removeField(): Remove a field from a rezrDF.

concatenateAll() longestLength() longest() shortestLength() shortest() inLength(): Functions for getting summary information about a vector of strings.

`%+%`: Concatenate two strings together with nothing in between.

mergeCats() renameCats(): Merging and renaming categories

stringToFactor(): Change the strings in a rezrDF to factors

TidyRez

Functions based on dplyr for dealing with rezrDFs with confidence.

rez_group_by() rez_ungroup(): Group / ungroup rezrDFs.

rez_add_row(): Add new rows to a rezrDF.

rez_bind_rows(): Bind together related rezrDF objects.

rez_group_split(): Perform a group_split on a rezrDF

rez_left_join(): Perform a left join on two rez data.frames and change field access status.

rez_mutate(): Mutate a Rez data.frame and change field access status.

rez_select(): Select columns in a rezrDF

rez_validate_fieldchange(): Validate a field change.

rez_rename(): Rename rezrDF columns.

EasyTrack

Functions for keeping track of track chains.

lastBridgeUnit() unitsToLastBridge() lastBridgeToken() tokensToLastBridge(): Functions related to bridging and frames.

getPosInChain(): Get the position of a chain entry (track or rez) in a chain (trail or resonance).

countCompetitors() countCompetitorsMatch() countMatchingCompetitors(): Count the number of competing referents to the current mention

mergedChunksToTrack(): Add merged chunks in the chunkDF to the trackDF

lastMentionUnit() unitsToLastMention() lastMentionToken() tokensToLastMention() countPrevMentions() countPrevMentionsIf() countPrevMentionsMatch() getPrevMentionField() nextMentionUnit() unitsToNextMention() nextMentionToken() tokensToNextMention() countNextMentions() countNextMentionsIf() countNextMentionsMatch() getNextMentionField() countPrevBridges(): Functions related to mentions of the same entity in previous/following context in track chains.

addFrameMatrix(): Add a frame matrix to trailDF.

frameMatrix() `frameMatrix<-`(): Extract/set a frameMatrix.

reducedFrameMatrix(): Extract a frameMatrix, removing rows and columns that do not participate in frame semantics.

obscureUpper(): Obscure the upper triangular portion of a frameMatrix.

updateFrameMatrixFromDF(): Update frameMatrix from an external source.

Trees

Functions for keeping track of trees.

getAllTreeCorrespondences(): Relate table rows to tree entries covering the same tokens.

mergeChunksWithTree(): Relate table rows to tree entries covering the same tokens.

addPositionAmongSiblings() addAllPositionsAmongSiblings(): Find the position of a chunk among its siblings in a tree.

getChildrenOfEntry() getChildrenOfChunk() getChildrenOfChunkIf() getSiblingsOfEntry() getSiblingsOfChunk() getSiblingOfChunkIf(): Get children and siblings of tree entries and chunks.

Resonance

Functions for keeping track of resonance and cliques.

augmentRezInfo(): Augment unitDF and cliqueDF with resonance-related information.

findResonancesBetween(): Find resonances.between two sets of units.

Other editing functions

Functions not ordinarily called by users, but may be used by advanced users. Subject to change without wwarning. Many are related to update functions.

new_rezrDF(): Constructor function for rezrDF

new_rezrObj(): Constructor function for rezrObj.

concatStringFields(): Concatenate string values in a lower-level data frame

createUpdateFunction(): Create an update function.

createLeftJoinUpdate(): Create a left join update function.

createLowerToHigherUpdate(): Create an update function based on a lowerToHigher-type action.

createRezId(): Create a Rezonator ID.

lowerToHigher(): Combine information from multiple entries in a lower-level source table to a higher-level target table.

rez_dfop(): Perform an operation on a data.frame while updating field access status.

new_updateFunction(): A constructor function for updateFunction objects

updateLeftJoin(): Update a field using a left join.

updateLowerToHigher(): Update a field using a lowerToHigher operation.

Datasets

Sample datasets for demonstration purposes.

sbc007: A Tree's Life - preliminary annotation