ctgov_kwic {ctrialsgov}

Keywords in Context

Description

Takes a keyword and vector of text and returns instances where the keyword is found within the text.

Usage

ctgov_kwic(
  term,
  text,
  names = NULL,
  n = Inf,
  ignore_case = TRUE,
  use_color = FALSE,
  width = 20L,
  output = c("cat", "character", "data.frame")
)

Arguments

term

search term as a string

text

vector of text to search

names

optional vector of names corresponding to the text

n

number of results to return; default is Inf

ignore_case

should search ignore case? default is TRUE

use_color

printed results include ASCII color escape sequences; these are set to FALSE because they only work correctly when returned in the terminal

width

how many characters to show as context

output

what kind of output to provide; default prints the results using cat

Value

either nothing, character vector, or data frame depending on the the requested return type