hs_update: Update annotations

In mdlincoln/hypothesisr: Wrapper for the 'Hypothes.is' Web Annotation Service

Description

Update annotations

Usage

hs_update(token, id, uri = NULL, user = NULL, permissions = NULL,
  document = NULL, target = NULL, tags = NULL, text = NULL,
  custom = NULL)

Arguments

token	Character. Your account token, which you can generate at https://hypothes.is/register.
id	Character. A hypothes.is annotation id.
uri	Character. The URI to be annotated.
user	Character. Your user account, normally in the format acct:[e-mail]
permissions	A named list with read, update, delete, and admin permissions. Defaults to setting global read permissions (group:__world__) and setting the user string for update, delete, and admin permissions.
document	A list describing the document. CURRENTLY IGNORED.
target	A list describing the highlight position of the annotation. CURRENTLY IGNORED
tags	Character. (optional) Tags to apply to the annotation.
text	Character. Text to put in the body of the annotation. This will be coerced into a character vector of length 1 using paste.
custom	Add arbitrary fields to the JSON object submitted to hypothes.is by means of a named list.

Value

TRUE on successful update.

Source

https://h.readthedocs.io/en/latest/api/#update

Examples

## Not run: 
hs_update(user_token, "lDf9rC3EEea6ck-G5kLdXA", text = "Now even more annotate-y!")

## End(Not run)

mdlincoln/hypothesisr documentation built on Aug. 30, 2019, 9:46 a.m.