rif_summary: Summary

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

Summary

Description

Summary

Usage

rif_summary(
  query,
  expandSynonyms = TRUE,
  expandAcronyms = FALSE,
  expandAbbrevs = FALSE,
  expandInferred = TRUE,
  key = NULL,
  ...
)

Arguments

query	Query terms
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

Examples

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

head( rif_summary("neuron")$result$federationSummary$results )
head(
 rif_summary("neuron", expandSynonyms=FALSE)$result$federationSummary$results
)
head(
 rif_summary("neuron", expandAbbrevs=TRUE)$result$federationSummary$results
)

rif_summary("cellular", verbose = TRUE)

## End(Not run)

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