Retreive all annotation search results as a data frame

Share:

Description

Takes the same arguments as hs_search and pages through all available results, formatting the output as a data.frame.

Usage

1
2
3
hs_search_all(sort = "updated", order = "asc", uri = NULL, user = NULL,
  text = NULL, any = NULL, custom = list(), pagesize = 200,
  progress = interactive())

Arguments

sort

Character. Specify which field the annotations should be sorted by: consumer, created, id, text, updated, uri, user.

order

Character. Specify which order annotations should be sorted by: asc or desc.

uri

Character. Search for annotations of a particular URI, for example www.example.com. URI searches will also find annotations of equivalent URIs. For example if the HTML document at http://www.example.com/document.html? includes a <link rel="canonical" href="http://www.example.com/canonical_document.html"> then annotations of http://www.example.com/canonical_document.html will also be included in the search results. Other forms of document equivalence that are supported include rel="alternate" links, DOIs, PDF file IDs, and more.

user

Character. Search for annotations by a particular user. For example, tim will find all annotations by users named tim at any provider, while tim@hypothes.is will only find annotations by tim on hypothes.is

text

Character. Search for annotations whose body text contains some text, for example: foobar.

any

Character. Search for annotations whose quote, tags, text, uri.parts or user fields match some query text.

custom

A named list of any field in the results returned by hypothes.is as a name, and the search text as values.

pagesize

Integer. How many annotations to retrieve per query. Between 1 and 200. (Default: 200)

progress

Boolean. Should a progress bar be displayed during download?

Value

A dataframe with annotation data.

Examples

1
2
3
4
## Not run: 
hs_search_all(text = "arxiv")

## End(Not run)