name_extract: name_extract

View source: R/name_extract.R

name_extractR Documentation

name_extract

Description

extract names using gnfinder

Usage

name_extract(
  path,
  verify = FALSE,
  language = NULL,
  no_bayes = FALSE,
  odds_details = FALSE,
  data_sources = NULL,
  tokens = NULL
)

Arguments

path

(character) path to a file

verify

(logical) verify names? default: FALSE

language

(logical) text's language. by default it's automatically detected. default: NULL

no_bayes

(logical) do not run Bayes algorithms. default: FALSE

odds_details

(logical) show details of odds calculation. default: FALSE

data_sources

(numeric vector) IDs of data sources to display for matches. default: NULL. e.g., c(1, 11, 179)

tokens

(logical) xxx. default: NULL

Value

list of two data.frames:

  • meta: metadata

  • names: names and their parts, varies based on function parameters

Examples

x <- system.file("examples/BoegerEtal2015.pdf", package="namext")
x
name_extract(x)
name_extract(x, verify = TRUE)
name_extract(x, language = "eng")
name_extract(x, no_bayes = TRUE)
name_extract(x, odds_details = TRUE)
name_extract(x, data_sources = c(4, 12))
name_extract(x, tokens = 5)

ropensci/namext documentation built on Sept. 11, 2022, 11:07 a.m.