fulltext (version 0.1.8)

ft_search: Search for full text

Description

ft_search is a one stop shop for searching for articles across many publishers and repositories. We currently support search for PLOS via the rplos package, Crossref via the rcrossref package, Entrez via the rentrez package, arXiv via the aRxiv package, and BMC and Biorxiv via internal helper functions in this package. Many publishers content is searchable via Crossref and Entrez - of course this doesn't mean that we can get full text for those articles. In the output objects of this function, we attempt to help by indicating what license is used for articles.

Usage

ft_search(query, from = "plos", limit = 10, plosopts = list(),
  bmcopts = list(), crossrefopts = list(), entrezopts = list(),
  arxivopts = list(), biorxivopts = list(), euroopts = list(),
  bmc_key = NULL, ...)

Arguments

query

Query terms

from

Source to query

limit

Number of records to return.

plosopts

PLOS options. See ?searchplos

bmcopts

BMC options. See ?bmc_search

crossrefopts

Crossref options. See ?cr_works

entrezopts

Entrez options. See ?entrez_search

arxivopts

arxiv options. See ?arxiv_search

biorxivopts

biorxiv options. See ?bx_search

euroopts

Euro PMC options. See ?eupmc_search

bmc_key

(character) A API key for Springer/BMC. See Details. Required when searching BMC - otherwise, not needed. Default: NULL

...

Further args passed on to GET. Not working right now...

Value

An object of class ft, and objects of class ft_ind within each source

BMC Authentication

BMC is integrated into Springer Publishers now, and that API requires an API key. Get your key by signing up here https://dev.springer.com/, then you'll get a key. Pass the key to the parameter bmc_key or to a param named key in the param bmcopts. However, the best option is to save the key in your .Renviron file like SPRINGER_KEY=yourkey, or in your .Rprofile file like springer_key="your key"

Examples

# NOT RUN {
# Plos
(res1 <- ft_search(query='ecology', from='plos'))
res1$plos
ft_search(query='climate change', from='plos', limit=500, plosopts=list(
   fl=c('id','author','eissn','journal','counter_total_all','alm_twitterCount')))

# Crossref
(res2 <- ft_search(query='ecology', from='crossref'))
res2$crossref

# BioRxiv
(res <- ft_search(query='ecology', from='biorxiv'))
res$biorxiv

# Entrez
(res <- ft_search(query='ecology', from='entrez'))
res$entrez

# arXiv
(res <- ft_search(query='ecology', from='arxiv'))
res$arxiv

# BMC - can be very slow
(res <- ft_search(query='ecology', from='bmc'))
res$bmc

# Europe PMC
(res <- ft_search(query='ecology', from='europmc'))
res$europmc

# PLOS, Crossref, and arxiv
(res <- ft_search(query='ecology', from=c('plos','crossref','arxiv')))
res$plos
res$arxiv
res$crossref
# }