federation_search: Federation search

In ropensci/rif: Client for 'Neuroscience' Information Framework 'APIs'

Federation search

Description

Federation search

Usage

federation_search(
  query,
  strict = FALSE,
  snippetCount = 0,
  expandSynonyms = TRUE,
  expandAcronyms = FALSE,
  expandAbbrevs = FALSE,
  expandInferred = TRUE,
  key = NULL,
  ...
)

Arguments

query	Query terms
strict	(logical) Only consider more relevant columns. Default: FALSE
snippetCount	How many snippets to return. Default: 0
expandSynonyms	(logical) Should recognized terms in the query have synonyms expanded? Default: TRUE
expandAcronyms	(logical) Default: FALSE
expandAbbrevs	(logical) Default: FALSE
expandInferred	(logical) Should recognized terms in the query have inferred terms expanded? Default: TRUE
key	(character) API key. required either passed in here or save as an env var or R option. see rif and Startup
...	Curl options passed on to HttpClient

See Also

Other federation: federation_data(), federation_facet()

Examples

## Not run: 
out <- federation_search("cellular")
out$query
out$messages
out$result$total
out$result$categories
head(out$result$results)

head( federation_search("cellular")$result$results )
head( federation_search("cellular", strict=TRUE)$result$results )
federation_search("cellular", snippetCount=3)

federation_search("cellular", verbose = TRUE)

## End(Not run)

ropensci/rif documentation built on May 18, 2022, 6:40 p.m.