dpla_collections | R Documentation |
Search collections from the Digital Public Library of America (DPLA).
dpla_collections(q = NULL, title = NULL, description = NULL, fields = NULL, sort_by = NULL, page_size = 10, page = NULL, key = NULL, ...)
q |
(character) Query terms. |
title |
(character) Query in the title field |
description |
(character) Query in the description field |
fields |
(character) A vector of the fields to return in the output. The default is all fields. See dpla_fields for options. |
sort_by |
(character) The default sort order is ascending. Most, but not all fields can be sorted on. Attempts to sort on an un-sortable field will return the standard error structure with a HTTP 400 status code. |
page_size |
(integer) Number of items to return. Default: 10. Max: 500. |
page |
(integer) Page number to return. Default: |
key |
(character) Your DPLA API key. See |
... |
Curl options passed on to |
A list with two slots:
meta - a tibble/data.frame of metadata for the response, with one row and two columns:
found - number of records found matching criteria
returned - number of records returned
data - a tibble/data.frame of the data; empty data.frame if no data matches your request; structure varies depending on search criteria
## Not run: dpla_collections(q="university of texas", page_size=2) dpla_collections(q="university of texas", fields='id', page_size=2) dpla_collections(q="university of texas", sort_by='title', page_size=5) dpla_collections(title="paso") dpla_collections(description="east") # use curl options dpla_collections(q="university", verbose = TRUE) ## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.