hep_search: Get INSPIRE HEP publications

Description Usage Arguments Value See Also Examples

View source: R/hep_search.r

Description

Search INSPIRE HEP, an open digital library for literature and data in the field of high energy physics.

Usage

1
hep_search(p = NULL, jrec = 1, batch_size = 10, limit = 100)

Arguments

p

search pattern (character vector). INSPIRE HEP supports different search syntaxes, including the SPIRES-style. See https://inspirehep.net/info/hep/search-tips for a comprehensive overview and examples on how to search HEP literature.

jrec

Navigate to a record in the search results. By default, retrieval starts with 1.

batch_size

number of records to be returned for each result page. By default, groups 10 records for each page. The maximum number is 250.

limit

Maximum number of records (default is 100). Since the API is still under development, be respectful and avoid expensive queries. INSPIRE allows bulk downloads via its OAI-PMH interface (https://inspirehep.net/oai2d?verb=Identify) or through a periodically updated json dump (https://inspirehep.net/hep_records.json.gz).

Value

The result is a data.frame with key metadata. If you wish to retrieve more details for each record see.

The data.frame has the following columns.

[,1] id INSPIRE HEP ID
[,2] title title of work
[,3] author first author
[,4] affiliation first author affiliation (collapsed ";")
[,5] doi Digital Object Identifier (DOI)
[,6] report_number eprint id from the arXiv (collapsed ";")
[,7] date_reported date of initial appearance of preprint
[,8] journal journal title
[,9] volume journal volume
[,10] issue journal issue
[,11] keywords controlled keywords (collapsed ";")
[,12] collection collection information (collapsed ";")
[,13] license_url re-use terms for full texts (e.g. CC)

See Also

https://inspirehep.net/info/hep/search-tips

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
## Not run: 
# Taken from the INSPIRE search guide 
# (https://inspirehep.net/info/hep/search-tips)
 
# keywords
hep_search('witten black hole', limit = 5)

# work by exact author
hep_search('exactauthor:D.J.Schwarz.1', limit = 5)

#Full text search available for arXiv eprints
hep_search('find ft "faster than light', limit = 5)

# Find caption
hep_search('find caption "Diagram for the fermion flow violating process"')

# Find eprints
hep_search('find eprint arxiv:0711.2908 or arxiv:0705.4298')

# Navigating the search results
# Get record positions 20 - 29
hep_search('witten black hole', jrec = 20, limit = 10)

## End(Not run)

njahn82/inspirehep documentation built on May 23, 2019, 7:06 p.m.