api-hypothesis: Hypothes.is API Utilities

In tjpalanca/tjutils: Utilities for TJ Palanca

Description

Hypothes.is is a tool for annotating anything on the web. I use this for highlighting online books and whatever information on the web in a lightweight way. I use the Hypothesis API to export the annotations and then be able to port that into Notion where I save all my reading for archival purposes.

Usage

hypothesis_api(api_key = Sys.getenv("HYPOTHESIS_API_KEY"))

hypothesis_search_annotations(
  wildcard_uri = NULL,
  username = NULL,
  limit = 200L,
  search_after = NULL,
  api_key = Sys.getenv("HYPOTHESIS_API_KEY")
)

hypothesis_get_annotations(
  wildcard_uri = NULL,
  username = NULL,
  limit = 200L,
  rows_limit = Inf,
  api_key = Sys.getenv("HYPOTHESIS_API_KEY")
)

hypothesis_process_annotations(annotations)

hypothesis_annotations(
  wildcard_uri = NULL,
  username = NULL,
  limit = 200L,
  rows_limit = Inf,
  api_key = Sys.getenv("HYPOTHESIS_API_KEY")
)

hypothesis_annotations_markdown(processed_annotations)

Arguments

api_key	Hypothesis API Key
wildcard_uri	URI matching (for example "https://google.com/*")
username	hypothes.is username
limit	limit for the number of annotations per request (max 200L)
search_after	search for rows created after this time
rows_limit	limit for the number of annotations in total (default Inf)
annotations	results of hypothesis_get_annotations()

Functions

• hypothesis_api: Hypothesis API Core Objects

• hypothesis_search_annotations: Perform an search for annotations

• hypothesis_get_annotations: Fetch a defined set of annotations

• hypothesis_process_annotations: Process annotations into the desired format

• hypothesis_annotations: Fetch annotations into a data frame

• hypothesis_annotations_markdown: Process annotations into markdown for pasting into Notion

tjpalanca/tjutils documentation built on Jan. 20, 2021, 2:01 p.m.