ztr_read_collection: Read A Specific Collection Or Sub-Collections Within A...

Description Usage Arguments Value Examples

View source: R/api_read.R

Description

Read A Specific Collection Or Sub-Collections Within A Specific Collection

Usage

1
ztr_read_collection(zotero_object, collection, sub = FALSE, ..., timeout = 20)

Arguments

zotero_object

Zotero object.

collection

Collection key.

sub

Specify whether to retrieve sub-collections within a specific collection. Otherwise, a specified collection will be retrieved.

...

Query inputs. See Read Requests and Sorting and Pagination in the Zotero Web API Documents for available query.

timeout

Seconds for the timeout of request (default: 20).

Value

httr::response object

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## Not run: 
ztr <- Zotero$new("ztr4r")

# simple example
ztr %>%
  ztr_read_collection(collection = "foo")

# example with query: sub-collections within a specific collection
ztr %>%
  ztr_read_collection(
    collection = "foo", sub = TRUE,
    format = "json", sort = "dateModified", direction = "asc", limit = 25, start = 0
  )

## End(Not run)

tellnnn/ztr4r documentation built on Dec. 23, 2021, 8:43 a.m.