Skip to contents

If you have a table resulting from search_text() or a module return object, you can expand the text column to the full sentence, paragraph, or section. You can also set plus and minus to append and prepend sentences to the result (only when expand_to is "sentence").

Usage

expand_text(
  results_table,
  paper,
  expand_to = c("sentence", "paragraph", "div", "section"),
  plus = 0,
  minus = 0
)

Arguments

results_table

the table to expand

paper

a papercheck paper object or a list of paper objects to look up the expanded text from

expand_to

whether to expand to the sentence, paragraph, div, or section level

plus

append additional sentences after the target expansion

minus

prepend additional sentences before the target expansion

Value

a results table with the expanded text

Examples

# single paper search
paper <- demoxml() |> read_grobid()
res_tbl <- search_text(paper, "p =", return = "match")
expanded <- expand_text(res_tbl, paper)

# multiple paper search
papers <- demodir() |> read_grobid()
res_tbl <- search_text(papers, "replicate", return = "sentence")
expanded <- expand_text(res_tbl, papers, plus = 1, minus = 1)