ztr_read_collections: Read (Top-Level) Collections In The Library

Description Usage Arguments Value Examples

View source: R/api_read.R

Description

Read (Top-Level) Collections In The Library

Usage

1
ztr_read_collections(zotero_object, top = FALSE, ..., timeout = 20)

Arguments

zotero_object

Zotero object.

top

Collection level (default: FALSE):

  • FALSE: All the collections in the library

  • TRUE : Top-level collections in the library

...

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_collections()

# example with query
ztr %>%
  ztr_read_collections(
    top = 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.