getSeqBounds: Get the max and min of a certain value from a lower object...

In johnwdubois/rezonateR: A Support Package for Working with Rezonator in R

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

Description

This is typically used for sequence or time.

Usage

getSeqBounds(
  simpleDF,
  complexDF,
  complexNodeMap,
  fieldnames,
  simpleIsAtom = T,
  seqName = "",
  tokenListName = "tokenList",
  exclude0 = T,
  ...
)

Arguments

simpleDF	The lower-level dataframe, for example the token dataframe for chunks and units, or the unit dataframe for stacks. There should either be an integer field that contains the sequence in question, or two integer fields containing the first and last (see simpleIsAtom).
complexDF	The dataframe that you're trying to add the concatenated fields to. We will create two integer fields, one for the first and one for the last integer.
complexNodeMap	The node map corresponding to the simpleDF.
fieldnames	The fields to be concatenated.
simpleIsAtom	If set to T, that means the simpleDF only contains single values, not a range. If set to F, that means the simpleDF contains a range, i.e. somethingFirst and somethingLast.
seqName	The name of the sequence in the lower table. By default it's docTokenseq or docTokenSeqFirst.
tokenListName	Name of the token list.
...	Additional fields 'simpleDFAddress', 'complexNodeMapAddress', 'fieldaccess' (foreign by default) from lowerToHigher(). Needed if you want automatically generated update functions.

Value

A complex DF.

Note

Most use cases should be handled by other functions like addUnitSeq and addIsWordField. If you do call this function, do note that the rezrDF you are changing is the second parameter, not the first. As such, piping should be done like this: someDF %>% getSeqBounds(simpleDF, ., complexNodeMap, ...)

Examples

sbc007_stackWithSeq = sbc007
sbc007_stackWithSeq$cardDF = sbc007$cardDF %>% rez_left_join(select(sbc007$unitDF, id, docTokenSeqFirst, docTokenSeqLast), by = c("unit" = "id"), fkey = "unit", df2Address = "unitDF", df2key = "id")
sbc007_stackWithSeq$stackDF = getSeqBounds(sbc007_stackWithSeq$cardDF, sbc007_stackWithSeq$stackDF, sbc007$nodeMap$stack, tokenListName = "setIDList", fieldnames = c("docTokenSeq"), simpleIsAtom = F, simpleDFAddress = "cardDF", complexNodeMapAddress = "stackDF")

johnwdubois/rezonateR documentation built on Nov. 19, 2024, 11:17 p.m.