rif (version 0.2.0)

literature_search: Literature search

Description

Literature search

Usage

literature_search(query, offset = 0, count = 20, minDate = NULL,
  maxDate = NULL, facetCount = 0, snippetCount = 0, minMatch = 60,
  searchFullText = FALSE, requireFullText = FALSE, authorFilter = NULL,
  yearFilter = NULL, journalFilter = NULL, sort = NULL, section = NULL,
  expandSynonyms = TRUE, expandAcronyms = FALSE, expandAbbrevs = FALSE,
  expandInferred = TRUE, highlight = FALSE, abstract = TRUE, key = NULL,
  ...)

Arguments

query

Query terms

offset

(integer) The result (row) to start on

count

(integer) The number of results (rows) to return. Default: 20

minDate

The minimum date (a unix time value - milliseconds since 1970)

maxDate

The maximum date (a unix time value - milliseconds since 1970)

facetCount

The facet count. Default: 0

snippetCount

The snippet count. Default: 0

minMatch

The Solr minmatch percentage. Default: 60 percent

searchFullText

Should full text be included in the search? Default: FALSE

requireFullText

Should only full text be included in the search? Default: FALSE

authorFilter

Author filters

yearFilter

Year filters

journalFilter

Journal filters

sort

Use "date" to sort by date. Otherwise relevancy will be used.

section

Sections to search

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

highlight

(no documentation provided). Default: FALSE

abstract

(no documentation provided). 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 <- literature_search(query = "cellular")
# out$result$publications
# out$result$facets
# out$query
# 
# literature_search(query = "ecology")
# literature_search(query = "ecology", searchFullText = FALSE)
# literature_search(query = "ecology", searchFullText = TRUE)
# literature_search(query = "ecology", requireFullText = TRUE)
## ---------------------------------------------