madoc_collection: Retrieve a collection from Madoc

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

Retrieve a collection from Madoc

Description

Get a data.frame of all manifests which are part of a collection by using the Madoc API's.
This function performs a GET request to /madoc/api/collections and handles pagination

Usage

madoc_collection(site, id, tidy_metadata = FALSE)

Arguments

site	character string with the site
id	the id of the collection
tidy_metadata	logical indicating to add the metadata in a tidy data.frame instead of a list column

Value

a data.frame with columns collection_id, manifest_id, manifest_type, manifest_label, manifest_canvasCount, manifest_thumbnail and manifest_metadata

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)
manifests <- madoc_collection(site = "https://www.madoc.ugent.be/s/brugse-vrije", 
                              id = projects$collection_id, tidy_metadata = TRUE)

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