spoa: Default function to search Springer open access material

Description Usage Arguments Details Value Examples

View source: R/spoa.R

Description

Default function to search Springer open access material

Usage

1
2
3
4
  spoa(terms, limit, startrecord = NA,
    url = "http://api.springer.com/openaccess/json",
    key = getOption("SpringerOAKey", stop("need an open access API key for Springer Journals")),
    ..., curl = getCurlHandle())

Arguments

terms

search terms (character)

limit

number of results to return (integer)

startrecord

return results starting at the number specified (integer)

fields

fields to return from search (character) [e.g., 'id,title'], any combination of search fields [see plosfields$field]

url

the base Springer url for the function (should be left to default)

key

your Springer API key, either enter, or loads from .Rprofile

...

optional additional curl options (debugging tools mostly)

curl

If using in a loop, call getCurlHandle() first and pass the returned value in here (avoids unnecessary footprint)

Details

Limited to 5 calls per second; 5000/day max.

Value

Number of search results and results in a data.frame.

Examples

1
2
3
4
5
## Not run: 
spoa(terms = 'dna', limit = 5)
spoa(terms = 'dna', limit = 5, verbose=TRUE) #debug mode

## End(Not run)

ropensci/rspringer documentation built on May 27, 2019, 6:34 p.m.