madoc_canvas_model: Retrieve canvas model annotations from Madoc

In DIGI-VUB/madoc.utils: Tools for interacting with Madoc

Retrieve canvas model annotations from Madoc

Description

Get a data.frame of annotations by using the Madoc API's.
This function performs a GET request to /madoc/api/canvases/canvas_id/models

Usage

madoc_canvas_model(site, id)

Arguments

site	character string with the site
id	an id of a canvas

Value

in case

• id is of length 1: a list with elements canvas_id and annotations where annotations is a data.frame with columns document_id, document_type, document_label, model_id, status, authors, id, type, value, label, id_revision, id_revises, selector_state, selector_type, selector_id.

• id is vector of length > 1: a data.frame with columns canvas_id, document_id, document_type, document_label, model_id, status, authors, id, type, value, label, id_revision, id_revises, selector_state, selector_type, selector_id. Containing only rows for canvasses which have annotations.

Examples

projects     <- madoc_projects("https://www.madoc.ugent.be/s/brugse-vrije")
manifests    <- madoc_collection(site = "https://www.madoc.ugent.be/s/brugse-vrije", 
                                 id = projects$collection_id)

ids          <- sample(manifests$manifest_id, size = 10)
canvasses    <- madoc_manifest(site = "https://www.madoc.ugent.be/s/brugse-vrije", 
                               id = ids)
annotations  <- madoc_canvas_model(site = "https://www.madoc.ugent.be/s/brugse-vrije", 
                                   id = ids)

DIGI-VUB/madoc.utils documentation built on Sept. 14, 2022, 3:03 p.m.